diff --git a/content/authentication/keeping-your-account-and-data-secure/about-authentication-to-github.md b/content/authentication/keeping-your-account-and-data-secure/about-authentication-to-github.md index 01bc39564381..ff27893c8e82 100644 --- a/content/authentication/keeping-your-account-and-data-secure/about-authentication-to-github.md +++ b/content/authentication/keeping-your-account-and-data-secure/about-authentication-to-github.md @@ -74,7 +74,7 @@ If you need to use multiple accounts on {% data variables.location.product_locat ### Session cookies -{% data variables.product.company_short %} uses cookies to provide services and increase security. {% ifversion fpt or ghec %}You can review details about {% data variables.product.company_short %}'s cookies in the [privacy/cookies repository](https://github.com/privacy/cookies).{% endif %} +{% data variables.product.company_short %} uses cookies to provide services and increase security. {% ifversion fpt or ghec %}You can review details about {% data variables.product.company_short %}'s cookies in [AUTOTITLE](/free-pro-team@latest/site-policy/privacy-policies/github-cookies).{% endif %} * The gist.{% ifversion fpt or ghec %}github.com{% elsif ghes %}HOSTNAME domain{% endif %} and {% ifversion fpt or ghec %}github.com domains{% elsif ghes %}base domain for your instance{% endif %} use separate cookies. * {% data variables.product.github %} typically marks a user session for deletion after two weeks of inactivity. diff --git a/content/authentication/securing-your-account-with-two-factor-authentication-2fa/about-mandatory-two-factor-authentication.md b/content/authentication/securing-your-account-with-two-factor-authentication-2fa/about-mandatory-two-factor-authentication.md index dee1471d61cc..b17f86dfb67b 100644 --- a/content/authentication/securing-your-account-with-two-factor-authentication-2fa/about-mandatory-two-factor-authentication.md +++ b/content/authentication/securing-your-account-with-two-factor-authentication-2fa/about-mandatory-two-factor-authentication.md @@ -53,7 +53,7 @@ Currently, we don't support passkeys or security keys as primary 2FA methods sin * [About email verification and mandatory 2FA](#about-email-verification-and-mandatory-2fa) > [!NOTE] -> We recommend retaining cookies on {% data variables.product.prodname_dotcom_the_website %}. If you set your browser to wipe your cookies every day, you'll never have a verified device for account recovery purposes, as the [`_device_id` cookie](https://github.com/privacy/cookies) is used to securely prove you've used that device previously. For more information, see [AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa/recovering-your-account-if-you-lose-your-2fa-credentials#authenticating-with-a-verified-device-ssh-token-or-personal-access-token). +> We recommend retaining cookies on {% data variables.product.prodname_dotcom_the_website %}. If you set your browser to wipe your cookies every day, you'll never have a verified device for account recovery purposes, as the [`_device_id` cookie](/free-pro-team@latest/site-policy/privacy-policies/github-cookies) is used to securely prove you've used that device previously. For more information, see [AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa/recovering-your-account-if-you-lose-your-2fa-credentials#authenticating-with-a-verified-device-ssh-token-or-personal-access-token). ### About TOTP apps and mandatory 2FA diff --git a/content/github-models/quickstart.md b/content/github-models/quickstart.md index a6a0dc5f305d..4dcb7e9a5064 100644 --- a/content/github-models/quickstart.md +++ b/content/github-models/quickstart.md @@ -50,7 +50,7 @@ To call models programmatically, you’ll need: -H "Content-Type: application/json" \ https://models.github.ai/inference/chat/completions \ -d '{"model":"openai/gpt-4.1","messages":[{"role":"user","content":"What is the capital of France?"}]}' - ``` + ``` 1. You’ll receive a response like this: diff --git a/content/rest/issues/index.md b/content/rest/issues/index.md index 1ebf572e68d6..355525ce0641 100644 --- a/content/rest/issues/index.md +++ b/content/rest/issues/index.md @@ -19,6 +19,7 @@ children: - /comments - /events - /issues + - /issue-dependencies - /labels - /milestones - /sub-issues diff --git a/content/rest/issues/issue-dependencies.md b/content/rest/issues/issue-dependencies.md new file mode 100644 index 000000000000..70a01b4624bd --- /dev/null +++ b/content/rest/issues/issue-dependencies.md @@ -0,0 +1,14 @@ +--- +title: REST API endpoints for issue dependencies +shortTitle: Issue dependencies +intro: Use the REST API to view, add, and remove issue dependencies. +versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖 + fpt: '*' + ghec: '*' +topics: + - API +autogenerated: rest +allowTitleToDifferFromFilename: true +--- + + diff --git a/content/rest/secret-scanning/index.md b/content/rest/secret-scanning/index.md index f11c3b31caf0..f26aa7cc78a0 100644 --- a/content/rest/secret-scanning/index.md +++ b/content/rest/secret-scanning/index.md @@ -12,6 +12,7 @@ topics: children: - /alert-dismissal-requests - /delegated-bypass + - /push-protection - /secret-scanning autogenerated: rest --- diff --git a/content/rest/secret-scanning/push-protection.md b/content/rest/secret-scanning/push-protection.md new file mode 100644 index 000000000000..bfaf48255b2d --- /dev/null +++ b/content/rest/secret-scanning/push-protection.md @@ -0,0 +1,14 @@ +--- +title: REST API endpoints for secret scanning push protection +shortTitle: Push protection +intro: Use the REST API to manage secret scanning push protection. +versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖 + fpt: '*' + ghec: '*' +topics: + - API +autogenerated: rest +allowTitleToDifferFromFilename: true +--- + + diff --git a/content/site-policy/privacy-policies/github-cookies.md b/content/site-policy/privacy-policies/github-cookies.md index 6c2a944409a2..77b481abaeee 100644 --- a/content/site-policy/privacy-policies/github-cookies.md +++ b/content/site-policy/privacy-policies/github-cookies.md @@ -10,8 +10,108 @@ topics: - Legal --- -GitHub uses cookies to provide and secure our websites, as well as to analyze the usage of our websites, in order to offer you a great user experience. Please take a look at our [Privacy Statement](/site-policy/privacy-policies/github-privacy-statement#our-use-of-cookies-and-tracking) if you’d like more information about cookies, and on how and why we use them. -You can view the current list of cookies on GitHub, and sign up to receive cookie list updates, at [https://github.com/privacy/cookies](https://github.com/privacy/cookies). +# Cookies -If you have questions or concerns about a new subprocessor, please contact us via {% data variables.contact.contact_privacy %}. +GitHub provides a great deal of transparency regarding how we use your data, how we collect your data, and with whom we share your data. To that end, we provide this page which details how we use cookies. + +GitHub uses cookies to provide and secure our websites, as well as to analyze the usage of our websites, in order to offer you a great user experience. Please take a look at our [Privacy Statement](/github/site-policy/github-privacy-statement#our-use-of-cookies-and-tracking-technologies) if you’d like more information about cookies, and on how and why we use them and cookie-related personal data. You can change your preference about non-essential cookies at any time by following [these instructions](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/managing-your-cookie-preferences-for-githubs-enterprise-marketing-pages). + +Since the number and names of cookies may change, the table below may be updated from time to time. To receive notifications of updates to this list, please follow the instructions provided in [About notifications](/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/about-notifications). + +Provider of Cookie | Cookie Name | Description | Expiration* +-----------------|-------------|-------------|------------ +GitHub | `app_manifest_token` | This cookie is used during the App Manifest flow to maintain the state of the flow during the redirect to fetch a user session. | Five minutes +GitHub | `color_mode` | This cookie is used to indicate the user selected theme preference. | Session +GitHub | `_device_id` | This cookie is used to track recognized devices for security purposes. | One year +GitHub | `dotcom_user` | This cookie is used to signal to us that the user is already logged in. | One year +GitHub | `enterprise_trial_redirect_to` | This cookie is used to complete a redirect for trial users | 5 minutes +GitHub | `fileTreeExpanded` | Used to indicate whether the file tree on the code view was last expanded or collapsed | 30 days +GitHub | `ghcc` | This cookie validates user's choice about cookies | 180 Days +GitHub | `_gh_ent` | This cookie is used for temporary application and framework state between pages like what step the customer is on in a multiple step form. | Two weeks +GitHub | `_gh_sess` | This cookie is used for temporary application and framework state between pages like what step the user is on in a multiple step form. | Session +GitHub | `gist_oauth_csrf` | This cookie is set by Gist to ensure the user that started the oauth flow is the same user that completes it. | Deleted when oauth state is validated +GitHub | `gist_user_session` | This cookie is used by Gist when running on a separate host. | Two weeks +GitHub | `has_recent_activity` | This cookie is used to prevent showing the security interstitial to users that have visited the app recently. | One hour +GitHub | `__Host-gist_user_session_same_site` | This cookie is set to ensure that browsers that support SameSite cookies can check to see if a request originates from GitHub. | Two weeks +GitHub | `__Host-user_session_same_site` | This cookie is set to ensure that browsers that support SameSite cookies can check to see if a request originates from GitHub. | Two weeks +GitHub | `logged_in` | This cookie is used to signal to us that the user is already logged in. | One year +GitHub | `marketplace_repository_ids` | This cookie is used for the marketplace installation flow. | One hour +GitHub | `marketplace_suggested_target_id` | This cookie is used for the marketplace installation flow. | One hour +GitHub | `_octo` | This cookie is used for session management including caching of dynamic content, conditional feature access, support request metadata, and first party analytics. | One year +GitHub | `org_transform_notice` | This cookie is used to provide notice during organization transforms. | One hour +GitHub | `private_mode_user_session` | This cookie is used for Enterprise authentication requests. | Two weeks +GitHub | `saml_csrf_token` | This cookie is set by SAML auth path method to associate a token with the client. | Until user closes browser or completes authentication request +GitHub | `saml_csrf_token_legacy` | This cookie is set by SAML auth path method to associate a token with the client. | Until user closes browser or completes authentication request +GitHub | `saml_return_to` | This cookie is set by the SAML auth path method to maintain state during the SAML authentication loop. | Until user closes browser or completes authentication request +GitHub | `saml_return_to_legacy` | This cookie is set by the SAML auth path method to maintain state during the SAML authentication loop. | Until user closes browser or completes authentication request +GitHub | `show_cookie_banner` | Set based on the client’s region and used to determine if a cookie consent banner should be shown | Session +GitHub | `tz` | This cookie allows us to customize timestamps to your time zone. | Session +GitHub | `user_session` | This cookie is used to log you in. | Two weeks +[Microsoft](https://privacy.microsoft.com/en-us/privacystatement) | `ai_session` | Application Insights session ID | One year +[Microsoft](https://privacy.microsoft.com/en-us/privacystatement) | `ai_user` | Application Insights user ID | 30 minutes +[Microsoft](https://privacy.microsoft.com/en-us/privacystatement) | `ANONCHK` | This Microsoft Clarity cookie monitors website performance | One year +[Microsoft](https://privacy.microsoft.com/en-us/privacystatement) | `isFirstSession` | This cookie is used when user opts-in to saving information | Session +[Microsoft](https://privacy.microsoft.com/en-us/privacystatement) | `MSO` | This cookie identifies a session | One year +[Microsoft](https://privacy.microsoft.com/en-us/privacystatement) | `MC1` | This cookie is used for advertising, site analytics, and other operational purposes | One year +[Microsoft](https://privacy.microsoft.com/en-us/privacystatement) | `MR` | This cookie checks whether to extend the lifetime of the MUID cookie | One year +[Microsoft](https://privacy.microsoft.com/en-us/privacystatement) | `MSFPC` | This cookie is used for advertising, site analytics, and other operational purposes | One year +[Microsoft](https://privacy.microsoft.com/en-us/privacystatement) | `MUID` | This cookie stores Bing’s visitor ID. This cookie is used for advertising, site analytics, and other operational purposes | 13 months +[Microsoft](https://privacy.microsoft.com/en-us/privacystatement) | `SM` | This cookie is used in synchronizing the MUID across Microsoft domains. | Session +[Microsoft](https://privacy.microsoft.com/en-us/privacystatement) | `_uetsid` | This cookie is used for analytics to store and track visits across sites | One year +[Microsoft](https://privacy.microsoft.com/en-us/privacystatement) | `_uetvid` | This cookie is used by Bing Ads to store and track visits across websites | 13 months +[Microsoft](https://privacy.microsoft.com/en-us/privacystatement) | `X-FD-FEATURES` | This cookie is used for tracking analytics and evenly spreading load on the website | One year +[Microsoft](https://privacy.microsoft.com/en-us/privacystatement) | `X-FD-Time` | This cookie is used for tracking analytics and evenly spreading load on website | One year +[Adobe](https://www.adobe.com/privacy/policy.html) | `aam_uuid` | This cookie is an audience manager | 13 months +[Adobe](https://www.adobe.com/privacy/policy.html) | `mboxEdgeCluster` | This cookie is used by Adobe Target load balancer. Adobe Target is used to determine which targeted content to display to visitor | 13 months +[Adobe](https://www.adobe.com/privacy/policy.html) | `AMCV_EA76ADE95776D2EC7F000101%40AdobeOrg` | Adobe cookie used to track and analyze user activities on the website | 13 months +[Adobe](https://www.adobe.com/privacy/policy.html) | `AMCVS_EA76ADE95776D2EC7F000101%40AdobeOrg` | Adobe cookie used to track and analyze user activities on the website | Session +[Adobe](https://www.adobe.com/privacy/policy.html) | `at_check` | Adobe Target to support conversion tracking for new product customers | Session +[Adobe](https://www.adobe.com/privacy/policy.html) | `mbox` | Adobe Target to store session ID | 13 months +[Contentsquare](https://go.contentsquare.com/en/tracking-tag-cookies) | `_cs_c` | Consent state: digit between 0 and 3. Used for capturing analytics on web pages | 13 months +[Contentsquare](https://go.contentsquare.com/en/tracking-tag-cookies) | `_cs_cvars` | This cookie is used to capture analytics on the web page | Session +[Contentsquare](https://go.contentsquare.com/en/tracking-tag-cookies) | `_cs_id` | Contains: user ID, timestamp (in seconds) of user creation, number of visits for this user | 13 months +[Contentsquare](https://go.contentsquare.com/en/tracking-tag-cookies) | `_cs_s` | Number of page views for the current session, and the recording state | One year +[Contentsquare](https://go.contentsquare.com/en/tracking-tag-cookies) | `__CT_Data` | This cookie is used to count the number of a guest’s pageviews or visits | One year +[Contentsquare](https://go.contentsquare.com/en/tracking-tag-cookies) | `_CT_RS_` | This cookie is used to capture analytics on the web page | One year +[Contentsquare](https://go.contentsquare.com/en/tracking-tag-cookies) | `WRUID` | This cookie is used for analytics | One year +[Facebook](https://www.facebook.com/policies/cookies/) | `_fbc` | This cookie is used to personalize content (including ads), measure ads, produce analytics, and provide a safer experience. | 90 Days +[Facebook](https://www.facebook.com/policies/cookies/) | `_fbp` | This cookie is used to personalize content (including ads), measure ads, produce analytics, and provide a safer experience. | 90 Days +[Facebook](https://www.facebook.com/policies/cookies/) | `fr` | This cookie is used as the primary advertising cookie used to deliver, measure, and improve the relevancy of ads. | 90 Days +[Facebook](https://www.facebook.com/policies/cookies/) | `wd` | This cookie is used to deliver an optimal experience for your device’s screen. | 7 Days +[Facebook](https://www.facebook.com/policies/cookies/) | `oo` | This cookie is an opt out cookie set by a user visiting Digital Advertising Alliance and choosing to opt out. | 5 years +[Fullstory](https://help.fullstory.com/hc/en-us/articles/360020623394-GDPR-FAQs) | `fs_uid` | This cookie is used to track interactions with a page | One year +[Google](https://policies.google.com/privacy) | `_gcl_au` | This cookie is used by Google AdSense for experimenting with advertisement efficiency across websites using their services. | 90 Days +[Google](https://policies.google.com/privacy) | `id` | This cookie is used to build a profile of the website visitor's interests and show relevant ads on other sites. | "OPT_OUT: fixed expiration (year 2030/11/09); non-OPT_OUT: 13 months EEA UK 24 months elsewhere" +[Google](https://policies.google.com/privacy) | `IDE` | This cookie is used to build a profile of the website visitor's interests and show relevant ads on other sites. | "13 months EEA UK; 24 months elsewhere" +[Google](https://policies.google.com/privacy) | `lsid` | This cookie is used to provide information about how the end user uses the website and any advertising that the end user may have seen before visiting the website. | 90 Days +[Google](https://policies.google.com/privacy) | `NID` | This cookie is used to build a profile of the website visitor's interests and show relevant ads on other sites. | 90 Days +[Google](https://policies.google.com/privacy) | `PREF` | This cookie is used to build a profile of the website visitor's interests and show relevant ads on other sites. | 90 Days +[Google](https://policies.google.com/privacy) | `SSID` | This cookie is used to provide information about how the end user uses the website and any advertising that the end user may have seen before visiting the website. | 90 Days +[Google](https://policies.google.com/privacy) | `SAPISID` | This cookie is used to build a profile of the website visitor's interests and show relevant ads on other sites. | 90 Days +[Google](https://policies.google.com/privacy) | `test_cookie` | This cookie is used to determine if the website visitor's browser supports cookies. | 90 Days +[LinkedIn](https://www.linkedin.com/legal/privacy-policy) | `bcookie` | This cookie is a browser identifier cookie to uniquely identify devices accessing LinkedIn to detect abuse on the platform. | One year +[LinkedIn](https://www.linkedin.com/legal/privacy-policy) | bscookie | This cookie is used for remembering that a logged in user is verified by two factor authentication. | One year +[LinkedIn](https://www.linkedin.com/legal/privacy-policy) | `u` | This cookie is used to provide a platform to enable advertisers to track users across multiple devices. | 3 months +[LinkedIn](https://www.linkedin.com/legal/privacy-policy) | `UserMatchHistory` | This cookie is used to track visitors so that more relevant ads can be presented based on the visitor's preferences. | One month +[LinkedIn](https://www.linkedin.com/legal/privacy-policy) | `JSESSIONID` | This cookie is used for Cross Site Request Forgery (CSRF) protection. | Session +[LinkedIn](https://www.linkedin.com/legal/privacy-policy) | `lang` | This cookie is used to remember a user's language setting to ensure LinkedIn.com displays in the language selected by the user in their settings. | Session +[LinkedIn](https://www.linkedin.com/legal/privacy-policy) | `lidc` | This cookie is used to faciliatate data center selection | 24 hours +[LinkedIn](https://www.linkedin.com/legal/privacy-policy) | `sdsc` | This cookie is used for database routing to ensure consistency across all databases when a change is made and to ensure that user-inputted content is immediately available to the submitting user upon submission. | Session +[LinkedIn](https://www.linkedin.com/legal/privacy-policy) | `li_gc` | This cookie is used to store consent of visitors regarding the use of cookies for non-essential purposes. | 6 months +[LinkedIn](https://www.linkedin.com/legal/privacy-policy) | `li_mc` | This cookie is used as a temporary cache to avoid database lookups for a member's consent for use of non-essential cookies and used for having consent information on the client side to enforce consent on the client side. | 6 months +[LinkedIn](https://www.linkedin.com/legal/privacy-policy) | `AnalyticsSyncHistory` | This cookie is used to store information about the time a sync took place with the lms_analytics cookie. | 30 Days +[LinkedIn](https://www.linkedin.com/legal/privacy-policy) | `lms_ads` | This cookie is used to identify LinkedIn Members off LinkedIn for advertising. | 30 Days +[LinkedIn](https://www.linkedin.com/legal/privacy-policy) | `lms_analytics` | This cookie is used to identify LinkedIn Members off LinkedIn for analytics. | 30 Days +[LinkedIn](https://www.linkedin.com/legal/privacy-policy) | `li_fat_id` | This cookie is used for conversion tracking, retargeting, analytics. | 30 Days +[LinkedIn](https://www.linkedin.com/legal/privacy-policy) | `li_sugr` | This cookie is used to make a probabilistic match of a user's identity. | 90 Days +[LinkedIn](https://www.linkedin.com/legal/privacy-policy) | `U` | This cookie is used as a browser identifier. | 3 months +[LinkedIn](https://www.linkedin.com/legal/privacy-policy) | BizographicsOptOutBizographicsOptOut | This cookie is used to determine opt-out status for non-members. | 10 years +[LinkedIn](https://www.linkedin.com/legal/privacy-policy) | `li_giant` | This cookie is used for conversion tracking. | 7 Days | https://www.linkedin.com/legal/privacy-policy +[Quantcast](https://www.quantcast.com/privacy/) | `cref` | This cookie is used for Market and Audience Segmentation and Targeted advertising services. | 13 months +[Quantcast](https://www.quantcast.com/privacy/) | `d` | This cookie is used for Market and Audience Segmentation and Targeted advertising services. | 3 months +[Quantcast](https://www.quantcast.com/privacy/) | `mc` | This cookie is used to track anonymous information about how website visitors use the site. | 13 months +[Yahoo](https://policies.yahoo.com/us/en/yahoo/privacy/index.htm?redirect=no) | `A3` | This cookie is used for search and advertising. | One year +[Yahoo](https://policies.yahoo.com/us/en/yahoo/privacy/index.htm?redirect=no) | `b` | This cookie collects anonymous data related to the visitor's website visits, such as the number of visits, average time spent on the website and what pages have been loaded. The registered data is used to categorize the users' interest and demographical profiles with the purpose of customizing the website content depending on the visitor. | One year + +(*) The expiration dates for the cookies listed above generally apply on a rolling basis. diff --git a/content/site-policy/privacy-policies/github-general-privacy-statement.md b/content/site-policy/privacy-policies/github-general-privacy-statement.md index 10d7315a9af1..2381437c2590 100644 --- a/content/site-policy/privacy-policies/github-general-privacy-statement.md +++ b/content/site-policy/privacy-policies/github-general-privacy-statement.md @@ -214,7 +214,7 @@ For translations of this statement into other languages, please visit Lists all artifacts for a repository.

\n

Anyone with read access to the repository can use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Lists all artifacts for a repository.

\n

Anyone with read access to the repository can use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

" + ] }, { "serverUrl": "https://api.github.com", @@ -576,13 +576,13 @@ } ], "previews": [], + "descriptionHTML": "

Deletes an artifact for a workflow run.\nOAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "descriptionHTML": "

Deletes an artifact for a workflow run.\nOAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" + ] }, { "serverUrl": "https://api.github.com", @@ -1491,13 +1491,13 @@ } ], "previews": [], + "descriptionHTML": "

Lists the GitHub Actions caches for a repository.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Lists the GitHub Actions caches for a repository.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" + ] }, { "serverUrl": "https://api.github.com", @@ -1659,13 +1659,13 @@ } ], "previews": [], + "descriptionHTML": "

Deletes one or more GitHub Actions caches for a repository, using a complete cache key. By default, all caches that match the provided key are deleted, but you can optionally provide a Git ref to restrict deletions to caches that match both the provided key and the Git ref.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Deletes one or more GitHub Actions caches for a repository, using a complete cache key. By default, all caches that match the provided key are deleted, but you can optionally provide a Git ref to restrict deletions to caches that match both the provided key and the Git ref.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" + ] }, { "serverUrl": "https://api.github.com", @@ -2083,13 +2083,13 @@ } ], "previews": [], + "descriptionHTML": "

Lists all GitHub-hosted runners configured in an organization.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runner:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Lists all GitHub-hosted runners configured in an organization.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runner:org scope to use this endpoint.

" + ] }, { "serverUrl": "https://api.github.com", @@ -2909,13 +2909,13 @@ } ], "previews": [], + "descriptionHTML": "

Get the list of machine specs available for GitHub-hosted runners for an organization.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Get the list of machine specs available for GitHub-hosted runners for an organization.

" + ] }, { "serverUrl": "https://api.github.com", @@ -3288,13 +3288,13 @@ } ], "previews": [], + "descriptionHTML": "

Gets a GitHub-hosted runner configured in an organization.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Gets a GitHub-hosted runner configured in an organization.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:org scope to use this endpoint.

" + ] }, { "serverUrl": "https://api.github.com", @@ -4306,8 +4306,8 @@ { "serverUrl": "https://api.github.com", "verb": "get", - "requestPath": "/orgs/{org}/actions/permissions", - "title": "Get GitHub Actions permissions for an organization", + "requestPath": "/organizations/{org}/actions/permissions/artifact-and-log-retention", + "title": "Get artifact and log retention settings for an organization", "category": "actions", "subcategory": "permissions", "parameters": [ @@ -4345,63 +4345,53 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "

Response

", + "description": "

Example response

", "example": { - "enabled_repositories": "all", - "allowed_actions": "selected", - "selected_actions_url": "https://api.github.com/organizations/42/actions/permissions/selected-actions" + "days": 90, + "maximum_allowed_days": 365 }, "schema": { "type": "object", "properties": { - "enabled_repositories": { - "type": "string", - "description": "The policy that controls the repositories in the organization that are allowed to run GitHub Actions.", - "enum": [ - "all", - "none", - "selected" - ] - }, - "selected_repositories_url": { - "type": "string", - "description": "The API URL to use to get or set the selected repositories that are allowed to run GitHub Actions, when `enabled_repositories` is set to `selected`." - }, - "allowed_actions": { - "type": "string", - "description": "The permissions policy that controls the actions and reusable workflows that are allowed to run.", - "enum": [ - "all", - "local_only", - "selected" - ] + "days": { + "type": "integer", + "description": "The number of days artifacts and logs are retained" }, - "selected_actions_url": { - "type": "string", - "description": "The API URL to use to get or set the actions and reusable workflows that are allowed to run, when `allowed_actions` is set to `selected`." + "maximum_allowed_days": { + "type": "integer", + "description": "The maximum number of days that can be configured" } }, "required": [ - "enabled_repositories" + "days", + "maximum_allowed_days" ] } } } ], "previews": [], + "descriptionHTML": "

Gets artifact and log retention settings for an organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope or the \"Actions policies\" fine-grained permission to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" } - ], - "descriptionHTML": "

Gets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization.

\n

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" + ] }, { "serverUrl": "https://api.github.com", "verb": "put", - "requestPath": "/orgs/{org}/actions/permissions", - "title": "Set GitHub Actions permissions for an organization", + "requestPath": "/organizations/{org}/actions/permissions/artifact-and-log-retention", + "title": "Set artifact and log retention settings for an organization", "category": "actions", "subcategory": "permissions", "parameters": [ @@ -4417,26 +4407,176 @@ ], "bodyParameters": [ { - "type": "string", - "name": "enabled_repositories", + "type": "integer", + "name": "days", "in": "body", - "description": "

The policy that controls the repositories in the organization that are allowed to run GitHub Actions.

", - "isRequired": true, - "enum": [ - "all", - "none", - "selected" - ] + "description": "

The number of days to retain artifacts and logs

", + "isRequired": true + } + ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Administration\" organization permissions": "write" + } + ] + }, + "codeExamples": [ + { + "key": "application/json", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "days": 100 + }, + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "204", + "description": "

No content

" + } + } + ], + "previews": [], + "descriptionHTML": "

Sets artifact and log retention settings for an organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope or the \"Actions policies\" fine-grained permission to use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "

No content

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "409", + "description": "

Conflict

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/organizations/{org}/actions/permissions/fork-pr-contributor-approval", + "title": "Get fork PR contributor approval permissions for an organization", + "category": "actions", + "subcategory": "permissions", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Administration\" organization permissions": "read" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "approval_policy": "first_time_contributors" + }, + "schema": { + "type": "object", + "properties": { + "approval_policy": { + "type": "string", + "enum": [ + "first_time_contributors_new_to_github", + "first_time_contributors", + "all_external_contributors" + ], + "description": "The policy that controls when fork PR workflows require approval from a maintainer." + } + }, + "required": [ + "approval_policy" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "

Gets the fork PR contributor approval policy for an organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope or the \"Actions policies\" fine-grained permission to use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/organizations/{org}/actions/permissions/fork-pr-contributor-approval", + "title": "Set fork PR contributor approval permissions for an organization", + "category": "actions", + "subcategory": "permissions", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ { "type": "string", - "name": "allowed_actions", + "name": "approval_policy", "in": "body", - "description": "

The permissions policy that controls the actions and reusable workflows that are allowed to run.

", + "description": "

The policy that controls when fork PR workflows require approval from a maintainer.

", + "isRequired": true, "enum": [ - "all", - "local_only", - "selected" + "first_time_contributors_new_to_github", + "first_time_contributors", + "all_external_contributors" ] } ], @@ -4455,11 +4595,10 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Set approval policy to first time contributors", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "enabled_repositories": "all", - "allowed_actions": "selected" + "approval_policy": "first_time_contributors" }, "parameters": { "org": "ORG" @@ -4472,19 +4611,27 @@ } ], "previews": [], + "descriptionHTML": "

Sets the fork PR contributor approval policy for an organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" } - ], - "descriptionHTML": "

Sets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" + ] }, { "serverUrl": "https://api.github.com", "verb": "get", - "requestPath": "/orgs/{org}/actions/permissions/repositories", - "title": "List selected repositories enabled for GitHub Actions in an organization", + "requestPath": "/organizations/{org}/actions/permissions/fork-pr-workflows-private-repos", + "title": "Get private repo fork PR workflow settings for an organization", "category": "actions", "subcategory": "permissions", "parameters": [ @@ -4496,23 +4643,393 @@ "schema": { "type": "string" } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Administration\" organization permissions": "read" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "run_workflows_from_fork_pull_requests": true, + "send_write_tokens_to_workflows": false, + "send_secrets_and_variables": false, + "require_approval_for_fork_pr_workflows": true + }, + "schema": { + "type": "object", + "required": [ + "run_workflows_from_fork_pull_requests", + "send_write_tokens_to_workflows", + "send_secrets_and_variables", + "require_approval_for_fork_pr_workflows" + ], + "properties": { + "run_workflows_from_fork_pull_requests": { + "type": "boolean", + "description": "Whether workflows triggered by pull requests from forks are allowed to run on private repositories." + }, + "send_write_tokens_to_workflows": { + "type": "boolean", + "description": "Whether GitHub Actions can create pull requests or submit approving pull request reviews from a workflow triggered by a fork pull request." + }, + "send_secrets_and_variables": { + "type": "boolean", + "description": "Whether to make secrets and variables available to workflows triggered by pull requests from forks." + }, + "require_approval_for_fork_pr_workflows": { + "type": "boolean", + "description": "Whether workflows triggered by pull requests from forks require approval from a repository administrator to run." + } + } + } + } + } + ], + "previews": [], + "descriptionHTML": "

Gets the settings for whether workflows from fork pull requests can run on private repositories in an organization.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" }, { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/organizations/{org}/actions/permissions/fork-pr-workflows-private-repos", + "title": "Set private repo fork PR workflow settings for an organization", + "category": "actions", + "subcategory": "permissions", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, "schema": { - "type": "integer", - "default": 30 + "type": "string" } + } + ], + "bodyParameters": [ + { + "type": "boolean", + "name": "run_workflows_from_fork_pull_requests", + "in": "body", + "description": "

Whether workflows triggered by pull requests from forks are allowed to run on private repositories.

", + "isRequired": true }, { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", + "type": "boolean", + "name": "send_write_tokens_to_workflows", + "in": "body", + "description": "

Whether GitHub Actions can create pull requests or submit approving pull request reviews from a workflow triggered by a fork pull request.

" + }, + { + "type": "boolean", + "name": "send_secrets_and_variables", + "in": "body", + "description": "

Whether to make secrets and variables available to workflows triggered by pull requests from forks.

" + }, + { + "type": "boolean", + "name": "require_approval_for_fork_pr_workflows", + "in": "body", + "description": "

Whether workflows triggered by pull requests from forks require approval from a repository administrator to run.

" + } + ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Administration\" organization permissions": "write" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "run_workflows_from_fork_pull_requests": true, + "send_write_tokens_to_workflows": false, + "send_secrets_and_variables": false, + "require_approval_for_fork_pr_workflows": true + }, + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "204", + "description": "

Empty response for successful settings update

" + } + } + ], + "previews": [], + "descriptionHTML": "

Sets the settings for whether workflows from fork pull requests can run on private repositories in an organization.

", + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "

Empty response for successful settings update

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden - Fork PR workflow settings for private repositories are managed by the enterprise owner

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/organizations/{org}/actions/permissions/self-hosted-runners", + "title": "Get self-hosted runners settings for an organization", + "category": "actions", + "subcategory": "permissions", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, "schema": { - "type": "integer", - "default": 1 + "type": "string" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Administration\" organization permissions": "read" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Example response

", + "example": { + "enabled_repositories": "selected", + "selected_repositories_url": "http://api.github.localhost/organizations/1/actions/permissions/self-hosted-runners/repositories" + }, + "schema": { + "type": "object", + "required": [ + "enabled_repositories" + ], + "properties": { + "enabled_repositories": { + "type": "string", + "description": "The policy that controls whether self-hosted runners can be used by repositories in the organization", + "enum": [ + "all", + "selected", + "none" + ] + }, + "selected_repositories_url": { + "type": "string", + "description": "The URL to the endpoint for managing selected repositories for self-hosted runners in the organization" + } + } + } + } + } + ], + "previews": [], + "descriptionHTML": "

Gets the settings for self-hosted runners for an organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope or the \"Actions policies\" fine-grained permission to use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/organizations/{org}/actions/permissions/self-hosted-runners", + "title": "Set self-hosted runners settings for an organization", + "category": "actions", + "subcategory": "permissions", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "enabled_repositories", + "in": "body", + "description": "

The policy that controls whether self-hosted runners can be used in the organization

", + "isRequired": true, + "enum": [ + "all", + "selected", + "none" + ] + } + ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Administration\" organization permissions": "write" + } + ] + }, + "codeExamples": [ + { + "key": "application/json", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "enabled_repositories": "all" + }, + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "204", + "description": "

No content

" + } + } + ], + "previews": [], + "descriptionHTML": "

Sets the settings for self-hosted runners for an organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope or the \"Actions policies\" fine-grained permission to use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "

No content

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "409", + "description": "

Conflict

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/organizations/{org}/actions/permissions/self-hosted-runners/repositories", + "title": "List repositories allowed to use self-hosted runners in an organization", + "category": "actions", + "subcategory": "permissions", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "in": "query", + "schema": { + "type": "integer", + "default": 1 } } ], @@ -4671,13 +5188,9 @@ }, "schema": { "type": "object", - "required": [ - "total_count", - "repositories" - ], "properties": { "total_count": { - "type": "number" + "type": "integer" }, "repositories": { "type": "array", @@ -5637,19 +6150,27 @@ } ], "previews": [], - "descriptionHTML": "

Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", + "descriptionHTML": "

Lists repositories that are allowed to use self-hosted runners in an organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope or the \"Actions policies\" fine-grained permission to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", - "requestPath": "/orgs/{org}/actions/permissions/repositories", - "title": "Set selected repositories enabled for GitHub Actions in an organization", + "requestPath": "/organizations/{org}/actions/permissions/self-hosted-runners/repositories", + "title": "Set repositories allowed to use self-hosted runners in an organization", "category": "actions", "subcategory": "permissions", "parameters": [ @@ -5668,7 +6189,7 @@ "type": "array of integers", "name": "selected_repository_ids", "in": "body", - "description": "

List of repository IDs to enable for GitHub Actions.

", + "description": "

IDs of repositories that can use repository-level self-hosted runners

", "isRequired": true } ], @@ -5684,15 +6205,16 @@ }, "codeExamples": [ { - "key": "default", + "key": "application/json", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "selected_repository_ids": [ - 32, - 42 + 1, + 2, + 3 ] }, "parameters": { @@ -5701,24 +6223,36 @@ }, "response": { "statusCode": "204", - "description": "

Response

" + "description": "

No content

" } } ], "previews": [], - "descriptionHTML": "

Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", + "descriptionHTML": "

Sets repositories that are allowed to use self-hosted runners in an organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope or the \"Actions policies\" fine-grained permission to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", - "description": "

No Content

" + "description": "

No content

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", - "requestPath": "/orgs/{org}/actions/permissions/repositories/{repository_id}", - "title": "Enable a selected repository for GitHub Actions in an organization", + "requestPath": "/organizations/{org}/actions/permissions/self-hosted-runners/repositories/{repository_id}", + "title": "Add a repository to the list of repositories allowed to use self-hosted runners in an organization", "category": "actions", "subcategory": "permissions", "parameters": [ @@ -5766,24 +6300,40 @@ }, "response": { "statusCode": "204", - "description": "

Response

" + "description": "

No content

" } } ], "previews": [], + "descriptionHTML": "

Adds a repository to the list of repositories that are allowed to use self-hosted runners in an organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope or the \"Actions policies\" fine-grained permission to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", - "description": "

No Content

" + "description": "

No content

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "409", + "description": "

Conflict

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" } - ], - "descriptionHTML": "

Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories must be must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"

\n

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" + ] }, { "serverUrl": "https://api.github.com", "verb": "delete", - "requestPath": "/orgs/{org}/actions/permissions/repositories/{repository_id}", - "title": "Disable a selected repository for GitHub Actions in an organization", + "requestPath": "/organizations/{org}/actions/permissions/self-hosted-runners/repositories/{repository_id}", + "title": "Remove a repository from the list of repositories allowed to use self-hosted runners in an organization", "category": "actions", "subcategory": "permissions", "parameters": [ @@ -5831,24 +6381,1581 @@ }, "response": { "statusCode": "204", - "description": "

Response

" + "description": "

No content

" } } ], "previews": [], - "descriptionHTML": "

Removes a repository from the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"

\n

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", + "descriptionHTML": "

Removes a repository from the list of repositories that are allowed to use self-hosted runners in an organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope or the \"Actions policies\" fine-grained permission to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", - "description": "

No Content

" + "description": "

No content

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "409", + "description": "

Conflict

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", - "requestPath": "/orgs/{org}/actions/permissions/selected-actions", - "title": "Get allowed actions and reusable workflows for an organization", + "requestPath": "/orgs/{org}/actions/permissions", + "title": "Get GitHub Actions permissions for an organization", + "category": "actions", + "subcategory": "permissions", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Administration\" organization permissions": "read" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "enabled_repositories": "all", + "allowed_actions": "selected", + "selected_actions_url": "https://api.github.com/organizations/42/actions/permissions/selected-actions" + }, + "schema": { + "type": "object", + "properties": { + "enabled_repositories": { + "type": "string", + "description": "The policy that controls the repositories in the organization that are allowed to run GitHub Actions.", + "enum": [ + "all", + "none", + "selected" + ] + }, + "selected_repositories_url": { + "type": "string", + "description": "The API URL to use to get or set the selected repositories that are allowed to run GitHub Actions, when `enabled_repositories` is set to `selected`." + }, + "allowed_actions": { + "type": "string", + "description": "The permissions policy that controls the actions and reusable workflows that are allowed to run.", + "enum": [ + "all", + "local_only", + "selected" + ] + }, + "selected_actions_url": { + "type": "string", + "description": "The API URL to use to get or set the actions and reusable workflows that are allowed to run, when `allowed_actions` is set to `selected`." + } + }, + "required": [ + "enabled_repositories" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "

Gets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization.

\n

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/orgs/{org}/actions/permissions", + "title": "Set GitHub Actions permissions for an organization", + "category": "actions", + "subcategory": "permissions", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "enabled_repositories", + "in": "body", + "description": "

The policy that controls the repositories in the organization that are allowed to run GitHub Actions.

", + "isRequired": true, + "enum": [ + "all", + "none", + "selected" + ] + }, + { + "type": "string", + "name": "allowed_actions", + "in": "body", + "description": "

The permissions policy that controls the actions and reusable workflows that are allowed to run.

", + "enum": [ + "all", + "local_only", + "selected" + ] + } + ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Administration\" organization permissions": "write" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "enabled_repositories": "all", + "allowed_actions": "selected" + }, + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "204", + "description": "

Response

" + } + } + ], + "previews": [], + "descriptionHTML": "

Sets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "

No Content

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/actions/permissions/repositories", + "title": "List selected repositories enabled for GitHub Actions in an organization", + "category": "actions", + "subcategory": "permissions", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Administration\" organization permissions": "read" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "total_count": 1, + "repositories": [ + { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "allow_rebase_merge": true, + "template_repository": null, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "allow_auto_merge": false, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + } + ] + }, + "schema": { + "type": "object", + "required": [ + "total_count", + "repositories" + ], + "properties": { + "total_count": { + "type": "number" + }, + "repositories": { + "type": "array", + "items": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "type": "string" + } + } + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + } + } + } + } + } + } + ], + "previews": [], + "descriptionHTML": "

Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/orgs/{org}/actions/permissions/repositories", + "title": "Set selected repositories enabled for GitHub Actions in an organization", + "category": "actions", + "subcategory": "permissions", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "array of integers", + "name": "selected_repository_ids", + "in": "body", + "description": "

List of repository IDs to enable for GitHub Actions.

", + "isRequired": true + } + ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Administration\" organization permissions": "write" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "selected_repository_ids": [ + 32, + 42 + ] + }, + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "204", + "description": "

Response

" + } + } + ], + "previews": [], + "descriptionHTML": "

Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "

No Content

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/orgs/{org}/actions/permissions/repositories/{repository_id}", + "title": "Enable a selected repository for GitHub Actions in an organization", + "category": "actions", + "subcategory": "permissions", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repository_id", + "description": "

The unique identifier of the repository.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Administration\" organization permissions": "write", + "\"Metadata\" repository permissions": "read" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "repository_id": "REPOSITORY_ID" + } + }, + "response": { + "statusCode": "204", + "description": "

Response

" + } + } + ], + "previews": [], + "descriptionHTML": "

Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories must be must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"

\n

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "

No Content

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "delete", + "requestPath": "/orgs/{org}/actions/permissions/repositories/{repository_id}", + "title": "Disable a selected repository for GitHub Actions in an organization", + "category": "actions", + "subcategory": "permissions", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repository_id", + "description": "

The unique identifier of the repository.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Administration\" organization permissions": "write", + "\"Metadata\" repository permissions": "read" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "repository_id": "REPOSITORY_ID" + } + }, + "response": { + "statusCode": "204", + "description": "

Response

" + } + } + ], + "previews": [], + "descriptionHTML": "

Removes a repository from the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"

\n

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "

No Content

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/actions/permissions/selected-actions", + "title": "Get allowed actions and reusable workflows for an organization", "category": "actions", "subcategory": "permissions", "parameters": [ @@ -6081,13 +8188,13 @@ } ], "previews": [], + "descriptionHTML": "

Gets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in an organization,\nas well as whether GitHub Actions can submit approving pull request reviews. For more information, see\n\"Setting the permissions of the GITHUB_TOKEN for your organization.\"

\n

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Gets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in an organization,\nas well as whether GitHub Actions can submit approving pull request reviews. For more information, see\n\"Setting the permissions of the GITHUB_TOKEN for your organization.\"

\n

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" + ] }, { "serverUrl": "https://api.github.com", @@ -6506,13 +8613,576 @@ } ], "previews": [], + "descriptionHTML": "

Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to private repositories.\nFor more information, see \"Allowing access to components in a private repository\".

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "

No Content

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/actions/permissions/artifact-and-log-retention", + "title": "Get artifact and log retention settings for a repository", + "category": "actions", + "subcategory": "permissions", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Administration\" repository permissions": "read" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "days": 90, + "maximum_allowed_days": 365 + }, + "schema": { + "type": "object", + "properties": { + "days": { + "type": "integer", + "description": "The number of days artifacts and logs are retained" + }, + "maximum_allowed_days": { + "type": "integer", + "description": "The maximum number of days that can be configured" + } + }, + "required": [ + "days", + "maximum_allowed_days" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "

Gets artifact and log retention settings for a repository.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/repos/{owner}/{repo}/actions/permissions/artifact-and-log-retention", + "title": "Set artifact and log retention settings for a repository", + "category": "actions", + "subcategory": "permissions", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "integer", + "name": "days", + "in": "body", + "description": "

The number of days to retain artifacts and logs

", + "isRequired": true + } + ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Administration\" repository permissions": "write" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Set retention days", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "days": 90 + }, + "parameters": { + "owner": "OWNER", + "repo": "REPO" + } + }, + "response": { + "statusCode": "204", + "description": "

Empty response for successful settings update

" + } + } + ], + "previews": [], + "descriptionHTML": "

Sets artifact and log retention settings for a repository.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "

Empty response for successful settings update

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/actions/permissions/fork-pr-contributor-approval", + "title": "Get fork PR contributor approval permissions for a repository", + "category": "actions", + "subcategory": "permissions", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Administration\" repository permissions": "read" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "approval_policy": "first_time_contributors" + }, + "schema": { + "type": "object", + "properties": { + "approval_policy": { + "type": "string", + "enum": [ + "first_time_contributors_new_to_github", + "first_time_contributors", + "all_external_contributors" + ], + "description": "The policy that controls when fork PR workflows require approval from a maintainer." + } + }, + "required": [ + "approval_policy" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "

Gets the fork PR contributor approval policy for a repository.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/repos/{owner}/{repo}/actions/permissions/fork-pr-contributor-approval", + "title": "Set fork PR contributor approval permissions for a repository", + "category": "actions", + "subcategory": "permissions", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "approval_policy", + "in": "body", + "description": "

The policy that controls when fork PR workflows require approval from a maintainer.

", + "isRequired": true, + "enum": [ + "first_time_contributors_new_to_github", + "first_time_contributors", + "all_external_contributors" + ] + } + ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Administration\" repository permissions": "write" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Set approval policy to first time contributors", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "approval_policy": "first_time_contributors" + }, + "parameters": { + "owner": "OWNER", + "repo": "REPO" + } + }, + "response": { + "statusCode": "204", + "description": "

Response

" + } + } + ], + "previews": [], + "descriptionHTML": "

Sets the fork PR contributor approval policy for a repository.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/actions/permissions/fork-pr-workflows-private-repos", + "title": "Get private repo fork PR workflow settings for a repository", + "category": "actions", + "subcategory": "permissions", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Administration\" repository permissions": "read" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "run_workflows_from_fork_pull_requests": true, + "send_write_tokens_to_workflows": false, + "send_secrets_and_variables": false, + "require_approval_for_fork_pr_workflows": true + }, + "schema": { + "type": "object", + "required": [ + "run_workflows_from_fork_pull_requests", + "send_write_tokens_to_workflows", + "send_secrets_and_variables", + "require_approval_for_fork_pr_workflows" + ], + "properties": { + "run_workflows_from_fork_pull_requests": { + "type": "boolean", + "description": "Whether workflows triggered by pull requests from forks are allowed to run on private repositories." + }, + "send_write_tokens_to_workflows": { + "type": "boolean", + "description": "Whether GitHub Actions can create pull requests or submit approving pull request reviews from a workflow triggered by a fork pull request." + }, + "send_secrets_and_variables": { + "type": "boolean", + "description": "Whether to make secrets and variables available to workflows triggered by pull requests from forks." + }, + "require_approval_for_fork_pr_workflows": { + "type": "boolean", + "description": "Whether workflows triggered by pull requests from forks require approval from a repository administrator to run." + } + } + } + } } ], - "descriptionHTML": "

Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to private repositories.\nFor more information, see \"Allowing access to components in a private repository\".

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" + "previews": [], + "descriptionHTML": "

Gets the settings for whether workflows from fork pull requests can run on a private repository.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/repos/{owner}/{repo}/actions/permissions/fork-pr-workflows-private-repos", + "title": "Set private repo fork PR workflow settings for a repository", + "category": "actions", + "subcategory": "permissions", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "boolean", + "name": "run_workflows_from_fork_pull_requests", + "in": "body", + "description": "

Whether workflows triggered by pull requests from forks are allowed to run on private repositories.

", + "isRequired": true + }, + { + "type": "boolean", + "name": "send_write_tokens_to_workflows", + "in": "body", + "description": "

Whether GitHub Actions can create pull requests or submit approving pull request reviews from a workflow triggered by a fork pull request.

" + }, + { + "type": "boolean", + "name": "send_secrets_and_variables", + "in": "body", + "description": "

Whether to make secrets and variables available to workflows triggered by pull requests from forks.

" + }, + { + "type": "boolean", + "name": "require_approval_for_fork_pr_workflows", + "in": "body", + "description": "

Whether workflows triggered by pull requests from forks require approval from a repository administrator to run.

" + } + ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Administration\" repository permissions": "write" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "run_workflows_from_fork_pull_requests": true, + "send_write_tokens_to_workflows": false, + "send_secrets_and_variables": false, + "require_approval_for_fork_pr_workflows": true + }, + "parameters": { + "owner": "OWNER", + "repo": "REPO" + } + }, + "response": { + "statusCode": "204", + "description": "

Empty response for successful settings update

" + } + } + ], + "previews": [], + "descriptionHTML": "

Sets the settings for whether workflows from fork pull requests can run on a private repository.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "

Empty response for successful settings update

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + } + ] }, { "serverUrl": "https://api.github.com", @@ -6781,13 +9451,13 @@ } ], "previews": [], + "descriptionHTML": "

Gets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in a repository,\nas well as if GitHub Actions can submit approving pull request reviews.\nFor more information, see \"Setting the permissions of the GITHUB_TOKEN for your repository.\"

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Gets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in a repository,\nas well as if GitHub Actions can submit approving pull request reviews.\nFor more information, see \"Setting the permissions of the GITHUB_TOKEN for your repository.\"

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" + ] }, { "serverUrl": "https://api.github.com", @@ -7394,6 +10064,7 @@ } ], "previews": [], + "descriptionHTML": "

Creates or updates an organization secret with an encrypted value. Encrypt your secret using\nLibSodium. For more information, see \"Encrypting secrets for the REST API.\"

\n

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "201", @@ -7403,8 +10074,7 @@ "httpStatusCode": "204", "description": "

Response when updating a secret

" } - ], - "descriptionHTML": "

Creates or updates an organization secret with an encrypted value. Encrypt your secret using\nLibSodium. For more information, see \"Encrypting secrets for the REST API.\"

\n

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" + ] }, { "serverUrl": "https://api.github.com", @@ -9581,13 +12251,13 @@ } ], "previews": [], + "descriptionHTML": "

Lists all secrets available in an environment without revealing their\nencrypted values.

\n

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Lists all secrets available in an environment without revealing their\nencrypted values.

\n

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" + ] }, { "serverUrl": "https://api.github.com", @@ -10264,13 +12934,13 @@ } ], "previews": [], + "descriptionHTML": "

Lists all self-hosted runner groups configured in an organization and inherited from an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Lists all self-hosted runner groups configured in an organization and inherited from an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" + ] }, { "serverUrl": "https://api.github.com", @@ -10477,13 +13147,13 @@ } ], "previews": [], + "descriptionHTML": "

Creates a new self-hosted runner group for an organization.

\n

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "201", "description": "

Created

" } - ], - "descriptionHTML": "

Creates a new self-hosted runner group for an organization.

\n

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" + ] }, { "serverUrl": "https://api.github.com", @@ -10895,13 +13565,13 @@ } ], "previews": [], + "descriptionHTML": "

Deletes a self-hosted runner group for an organization.

\n

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "descriptionHTML": "

Deletes a self-hosted runner group for an organization.

\n

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" + ] }, { "serverUrl": "https://api.github.com", @@ -12451,13 +15121,13 @@ } ], "previews": [], + "descriptionHTML": "

Lists the repositories with access to a self-hosted runner group configured in an organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Lists the repositories with access to a self-hosted runner group configured in an organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" + ] }, { "serverUrl": "https://api.github.com", @@ -12680,13 +15350,13 @@ } ], "previews": [], + "descriptionHTML": "

Removes a repository from the list of selected repositories that can access a self-hosted runner group. The runner group must have visibility set to selected. For more information, see \"Create a self-hosted runner group for an organization.\"

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "descriptionHTML": "

Removes a repository from the list of selected repositories that can access a self-hosted runner group. The runner group must have visibility set to selected. For more information, see \"Create a self-hosted runner group for an organization.\"

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" + ] }, { "serverUrl": "https://api.github.com", @@ -15881,13 +18551,13 @@ } ], "previews": [], + "descriptionHTML": "

Returns a token that you can pass to the config script to remove a self-hosted runner from an organization. The token expires after one hour.

\n

For example, you can replace TOKEN in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization:

\n
./config.sh remove --token TOKEN\n
\n

Authenticated users must have admin access to the organization to use this endpoint.

\n

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "201", "description": "

Created

" } - ], - "descriptionHTML": "

Returns a token that you can pass to the config script to remove a self-hosted runner from an organization. The token expires after one hour.

\n

For example, you can replace TOKEN in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization:

\n
./config.sh remove --token TOKEN\n
\n

Authenticated users must have admin access to the organization to use this endpoint.

\n

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" + ] }, { "serverUrl": "https://api.github.com", @@ -16061,13 +18731,13 @@ } ], "previews": [], + "descriptionHTML": "

Gets a specific self-hosted runner configured in an organization.

\n

Authenticated users must have admin access to the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Gets a specific self-hosted runner configured in an organization.

\n

Authenticated users must have admin access to the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

" + ] }, { "serverUrl": "https://api.github.com", @@ -17102,13 +19772,13 @@ } ], "previews": [], + "descriptionHTML": "

Lists all self-hosted runners configured in a repository.

\n

Authenticated users must have admin access to the repository to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Lists all self-hosted runners configured in a repository.

\n

Authenticated users must have admin access to the repository to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" + ] }, { "serverUrl": "https://api.github.com", @@ -18556,13 +21226,13 @@ } ], "previews": [], + "descriptionHTML": "

Returns a token that you can pass to the config script. The token expires after one hour.

\n

For example, you can replace TOKEN in the following example with the registration token provided by this endpoint to configure your self-hosted runner:

\n
./config.sh --url https://github.com/octo-org --token TOKEN\n
\n

Authenticated users must have admin access to the repository to use this endpoint.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "201", "description": "

Created

" } - ], - "descriptionHTML": "

Returns a token that you can pass to the config script. The token expires after one hour.

\n

For example, you can replace TOKEN in the following example with the registration token provided by this endpoint to configure your self-hosted runner:

\n
./config.sh --url https://github.com/octo-org --token TOKEN\n
\n

Authenticated users must have admin access to the repository to use this endpoint.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" + ] }, { "serverUrl": "https://api.github.com", @@ -20847,13 +23517,13 @@ } ], "previews": [], + "descriptionHTML": "

Lists all organization variables.

\n

Authenticated users must have collaborator access to a repository to create, update, or read variables.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Lists all organization variables.

\n

Authenticated users must have collaborator access to a repository to create, update, or read variables.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

" + ] }, { "serverUrl": "https://api.github.com", @@ -21086,13 +23756,13 @@ } ], "previews": [], + "descriptionHTML": "

Gets a specific variable in an organization.

\n

The authenticated user must have collaborator access to a repository to create, update, or read variables.

\n

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Gets a specific variable in an organization.

\n

The authenticated user must have collaborator access to a repository to create, update, or read variables.

\n

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" + ] }, { "serverUrl": "https://api.github.com", @@ -23220,13 +25890,13 @@ } ], "previews": [], + "descriptionHTML": "

Deletes a repository variable using the variable name.

\n

Authenticated users must have collaborator access to a repository to create, update, or read variables.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "descriptionHTML": "

Deletes a repository variable using the variable name.

\n

Authenticated users must have collaborator access to a repository to create, update, or read variables.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" + ] }, { "serverUrl": "https://api.github.com", @@ -24374,13 +27044,13 @@ } ], "previews": [], + "descriptionHTML": "

Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look\nfor Location: in the response header to find the URL for the download.

\n

Anyone with read access to the repository can use this endpoint.

\n

If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "302", "description": "

Found

" } - ], - "descriptionHTML": "

Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look\nfor Location: in the response header to find the URL for the download.

\n

Anyone with read access to the repository can use this endpoint.

\n

If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" + ] }, { "serverUrl": "https://api.github.com", @@ -25549,6 +28219,7 @@ } ], "previews": [], + "descriptionHTML": "

Re-run a job and its dependent jobs in a workflow run.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "201", @@ -25558,8 +28229,7 @@ "httpStatusCode": "403", "description": "

Forbidden

" } - ], - "descriptionHTML": "

Re-run a job and its dependent jobs in a workflow run.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" + ] }, { "serverUrl": "https://api.github.com", @@ -31317,13 +33987,13 @@ } ], "previews": [], + "descriptionHTML": "

Gets a specific workflow run.

\n

Anyone with read access to the repository can use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Gets a specific workflow run.

\n

Anyone with read access to the repository can use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

" + ] }, { "serverUrl": "https://api.github.com", @@ -35813,13 +38483,13 @@ } ], "previews": [], + "descriptionHTML": "

Get all deployment environments for a workflow run that are waiting for protection rules to pass.

\n

Anyone with read access to the repository can use this endpoint.

\n

If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Get all deployment environments for a workflow run that are waiting for protection rules to pass.

\n

Anyone with read access to the repository can use this endpoint.

\n

If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" + ] }, { "serverUrl": "https://api.github.com", @@ -36873,13 +39543,13 @@ } ], "previews": [], + "descriptionHTML": "

Re-run all of the failed jobs and their dependent jobs in a workflow run using the id of the workflow run.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "201", "description": "

Created

" } - ], - "descriptionHTML": "

Re-run all of the failed jobs and their dependent jobs in a workflow run using the id of the workflow run.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" + ] }, { "serverUrl": "https://api.github.com", @@ -40660,13 +43330,13 @@ } ], "previews": [], + "descriptionHTML": "

You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace workflow_id with the workflow file name. For example, you could use main.yaml.

\n

You must configure your GitHub Actions workflow to run when the workflow_dispatch webhook event occurs. The inputs are configured in the workflow file. For more information about how to configure the workflow_dispatch event in the workflow file, see \"Events that trigger workflows.\"

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "descriptionHTML": "

You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace workflow_id with the workflow file name. For example, you could use main.yaml.

\n

You must configure your GitHub Actions workflow to run when the workflow_dispatch webhook event occurs. The inputs are configured in the workflow file. For more information about how to configure the workflow_dispatch event in the workflow file, see \"Events that trigger workflows.\"

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" + ] }, { "serverUrl": "https://api.github.com", @@ -43865,6 +46535,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -47689,6 +50383,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -51507,6 +54225,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -52312,13 +55054,13 @@ } ], "previews": [], + "descriptionHTML": "

Note

\n

\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.

\n
", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Note

\n

\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.

\n
" + ] }, { "serverUrl": "https://api.github.com", @@ -55323,6 +58065,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -59125,6 +61891,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -62951,6 +65741,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -66753,6 +69567,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -70566,6 +73404,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -74379,6 +77241,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -96910,13 +99796,13 @@ } ], "previews": [], + "descriptionHTML": "

Enables an authenticated GitHub App to find the organization's installation information.

\n

You must use a JWT to access this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Enables an authenticated GitHub App to find the organization's installation information.

\n

You must use a JWT to access this endpoint.

" + ] }, { "serverUrl": "https://api.github.com", @@ -173952,6 +176838,7 @@ } ], "previews": [], + "descriptionHTML": "

Sets a code security configuration as a default to be applied to new repositories in your enterprise.

\n

This configuration will be applied by default to the matching repository type when created, but only for organizations within the enterprise that do not already have a default code security configuration set.

\n

The authenticated user must be an administrator for the enterprise to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -173965,8 +176852,7 @@ "httpStatusCode": "404", "description": "

Resource not found

" } - ], - "descriptionHTML": "

Sets a code security configuration as a default to be applied to new repositories in your enterprise.

\n

This configuration will be applied by default to the matching repository type when created, but only for organizations within the enterprise that do not already have a default code security configuration set.

\n

The authenticated user must be an administrator for the enterprise to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

" + ] }, { "serverUrl": "https://api.github.com", @@ -208676,13 +211562,13 @@ } ], "previews": [], + "descriptionHTML": "

Lists all Codespaces development environment secrets available at the organization-level without revealing their encrypted\nvalues.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Lists all Codespaces development environment secrets available at the organization-level without revealing their encrypted\nvalues.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" + ] }, { "serverUrl": "https://api.github.com", @@ -224723,13 +227609,13 @@ } ], "previews": [], + "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "descriptionHTML": "" + ] }, { "serverUrl": "https://api.github.com", @@ -236238,13 +239124,13 @@ } ], "previews": [], + "descriptionHTML": "

Lists the commit comments for a specified repository. Comments are ordered by ascending ID.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Lists the commit comments for a specified repository. Comments are ordered by ascending ID.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n" + ] }, { "serverUrl": "https://api.github.com", @@ -242167,7 +245053,7 @@ } ], "previews": [], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Lists all Copilot seats for which an organization with a Copilot Business or Copilot Enterprise subscription is currently being billed.\nOnly organization owners can view assigned seats.

\n

Each seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in last_activity_at.\nFor more information about activity data, see \"Reviewing user activity data for Copilot in your organization.\"

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or read:org scopes to use this endpoint.

", + "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Lists all Copilot seats for which an organization with a Copilot Business or Copilot Enterprise subscription is currently being billed.\nOnly organization owners can view assigned seats.

\n

Each seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in last_activity_at.\nFor more information about activity data, see Metrics data properties for GitHub Copilot.

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or read:org scopes to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -243366,7 +246252,7 @@ } ], "previews": [], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Gets the GitHub Copilot seat details for a member of an organization who currently has access to GitHub Copilot.

\n

The seat object contains information about the user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in last_activity_at.\nFor more information about activity data, see \"Reviewing user activity data for Copilot in your organization.\"

\n

Only organization owners can view Copilot seat assignment details for members of their organization.

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or read:org scopes to use this endpoint.

", + "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Gets the GitHub Copilot seat details for a member of an organization who currently has access to GitHub Copilot.

\n

The seat object contains information about the user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in last_activity_at.\nFor more information about activity data, see Metrics data properties for GitHub Copilot.

\n

Only organization owners can view Copilot seat assignment details for members of their organization.

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or read:org scopes to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -251777,13 +254663,13 @@ } ], "previews": [], + "descriptionHTML": "

Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" + ] }, { "serverUrl": "https://api.github.com", @@ -253204,13 +256090,13 @@ } ], "previews": [], + "descriptionHTML": "

Replaces all repositories for an organization secret when the visibility\nfor repository access is set to selected. The visibility is set when you Create\nor update an organization secret.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "descriptionHTML": "

Replaces all repositories for an organization secret when the visibility\nfor repository access is set to selected. The visibility is set when you Create\nor update an organization secret.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" + ] }, { "serverUrl": "https://api.github.com", @@ -253279,6 +256165,7 @@ } ], "previews": [], + "descriptionHTML": "

Adds a repository to an organization secret when the visibility for\nrepository access is set to selected. The visibility is set when you Create or\nupdate an organization secret.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", @@ -253288,8 +256175,7 @@ "httpStatusCode": "409", "description": "

Conflict when visibility type is not set to selected

" } - ], - "descriptionHTML": "

Adds a repository to an organization secret when the visibility for\nrepository access is set to selected. The visibility is set when you Create or\nupdate an organization secret.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" + ] }, { "serverUrl": "https://api.github.com", @@ -253358,6 +256244,7 @@ } ], "previews": [], + "descriptionHTML": "

Removes a repository from an organization secret when the visibility\nfor repository access is set to selected. The visibility is set when you Create\nor update an organization secret.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", @@ -253367,8 +256254,7 @@ "httpStatusCode": "409", "description": "

Conflict when visibility type not set to selected

" } - ], - "descriptionHTML": "

Removes a repository from an organization secret when the visibility\nfor repository access is set to selected. The visibility is set when you Create\nor update an organization secret.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" + ] }, { "serverUrl": "https://api.github.com", @@ -255386,13 +258272,13 @@ } ], "previews": [], + "descriptionHTML": "

Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "descriptionHTML": "

Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead.

" + ] } ] }, @@ -262150,13 +265036,13 @@ } ], "previews": [], + "descriptionHTML": "

Disables a custom deployment protection rule for an environment.

\n

The authenticated user must have admin or owner permissions to the repository to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "descriptionHTML": "

Disables a custom deployment protection rule for an environment.

\n

The authenticated user must have admin or owner permissions to the repository to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" + ] } ], "statuses": [ @@ -266654,6 +269540,7 @@ } ], "previews": [], + "descriptionHTML": "

Lists all the emojis available to use on GitHub.

", "statusCodes": [ { "httpStatusCode": "200", @@ -266663,8 +269550,7 @@ "httpStatusCode": "304", "description": "

Not modified

" } - ], - "descriptionHTML": "

Lists all the emojis available to use on GitHub.

" + ] } ] }, @@ -284222,6 +287108,7 @@ } ], "previews": [], + "descriptionHTML": "

Get the content of a gitignore template.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "statusCodes": [ { "httpStatusCode": "200", @@ -284231,8 +287118,7 @@ "httpStatusCode": "304", "description": "

Not modified

" } - ], - "descriptionHTML": "

Get the content of a gitignore template.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n" + ] } ] }, @@ -284336,13 +287222,13 @@ } ], "previews": [], + "descriptionHTML": "

Shows which type of GitHub user can interact with this organization and when the restriction expires. If there is no restrictions, you will see an empty response.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Shows which type of GitHub user can interact with this organization and when the restriction expires. If there is no restrictions, you will see an empty response.

" + ] }, { "serverUrl": "https://api.github.com", @@ -288300,6 +291186,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -291515,6 +294425,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -294652,6 +297586,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -297722,6 +300680,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -300758,6 +303740,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -303867,6 +306873,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -307267,6 +310297,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -307588,6 +310642,7 @@ } ], "previews": [], + "descriptionHTML": "

Lists the available assignees for issues in a repository.

", "statusCodes": [ { "httpStatusCode": "200", @@ -307597,8 +310652,7 @@ "httpStatusCode": "404", "description": "

Resource not found

" } - ], - "descriptionHTML": "

Lists the available assignees for issues in a repository.

" + ] }, { "serverUrl": "https://api.github.com", @@ -310672,6 +313726,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -313700,6 +316778,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -321450,6 +324552,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -326227,6 +329353,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -339138,51 +342288,12325 @@ "events" ] }, - "project_card": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - }, - "project_id": { - "type": "integer" - }, - "project_url": { - "type": "string", - "format": "uri" - }, - "column_name": { - "type": "string" - }, - "previous_column_name": { - "type": "string" - } - }, - "required": [ - "id", - "url", - "project_id", - "project_url", - "column_name" - ] + "project_card": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + }, + "project_id": { + "type": "integer" + }, + "project_url": { + "type": "string", + "format": "uri" + }, + "column_name": { + "type": "string" + }, + "previous_column_name": { + "type": "string" + } + }, + "required": [ + "id", + "url", + "project_id", + "project_url", + "column_name" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "actor", + "event", + "commit_id", + "commit_url", + "created_at", + "performed_via_github_app" + ] + } + ] + } + } + } + } + ], + "previews": [], + "descriptionHTML": "

Lists all events for an issue.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "410", + "description": "

Gone

" + } + ] + } + ], + "issue-dependencies": [ + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_by", + "title": "List dependencies an issue is blocked by", + "category": "issues", + "subcategory": "issue-dependencies", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "issue_number", + "description": "

The number that identifies the issue.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "per_page", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Issues\" repository permissions": "read" + } + ], + "allowsPublicRead": true + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "issue_number": "ISSUE_NUMBER" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": [ + { + "id": 1, + "node_id": "MDU6SXNzdWUx", + "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", + "repository_url": "https://api.github.com/repos/octocat/Hello-World", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", + "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events", + "html_url": "https://github.com/octocat/Hello-World/issues/1347", + "number": 1347, + "state": "open", + "title": "Found a bug", + "body": "I'm having a problem with this.", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "labels": [ + { + "id": 208045946, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", + "name": "bug", + "description": "Something isn't working", + "color": "f29513", + "default": true + } + ], + "assignee": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "assignees": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + ], + "milestone": { + "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", + "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", + "id": 1002604, + "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", + "number": 1, + "state": "open", + "title": "v1.0", + "description": "Tracking milestone for version 1.0", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "open_issues": 4, + "closed_issues": 8, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z", + "closed_at": "2013-02-12T13:22:01Z", + "due_on": "2012-10-09T23:39:01Z" + }, + "locked": true, + "active_lock_reason": "too heated", + "comments": 0, + "pull_request": { + "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", + "html_url": "https://github.com/octocat/Hello-World/pull/1347", + "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", + "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch" + }, + "closed_at": null, + "created_at": "2011-04-22T13:33:48Z", + "updated_at": "2011-04-22T13:33:48Z", + "closed_by": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "author_association": "COLLABORATOR", + "state_reason": "completed" + } + ], + "schema": { + "type": "array", + "items": { + "title": "Issue", + "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repositories/42/issues/1" + ] + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "labels_url": { + "type": "string" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "number": { + "description": "Number uniquely identifying the issue within its repository", + "type": "integer", + "examples": [ + 42 + ] + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "examples": [ + "open" + ] + }, + "state_reason": { + "description": "The reason for the current state", + "type": [ + "string", + "null" + ], + "enum": [ + "completed", + "reopened", + "not_planned", + "duplicate", + null + ], + "examples": [ + "not_planned" + ] + }, + "title": { + "description": "Title of the issue", + "type": "string", + "examples": [ + "Widget creation fails in Safari on OS X 10.8" + ] + }, + "body": { + "description": "Contents of the issue", + "type": [ + "string", + "null" + ], + "examples": [ + "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?" + ] + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "labels": { + "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", + "type": "array", + "items": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "name": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "color": { + "type": [ + "string", + "null" + ] + }, + "default": { + "type": "boolean" + } + } + } + ] + }, + "examples": [ + "bug", + "registration" + ] + }, + "assignee": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "assignees": { + "type": [ + "array", + "null" + ], + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "milestone": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/milestones/v1.0" + ] + }, + "labels_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1002604 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDk6TWlsZXN0b25lMTAwMjYwNA==" + ] + }, + "number": { + "description": "The number of the milestone.", + "type": "integer", + "examples": [ + 42 + ] + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open", + "examples": [ + "open" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string", + "examples": [ + "v1.0" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "Tracking milestone for version 1.0" + ] + }, + "creator": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 4 + ] + }, + "closed_issues": { + "type": "integer", + "examples": [ + 8 + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-10T20:09:31Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2014-03-03T18:58:10Z" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2013-02-12T13:22:01Z" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2012-10-09T23:39:01Z" + ] + } + }, + "required": [ + "closed_issues", + "creator", + "description", + "due_on", + "closed_at", + "id", + "node_id", + "labels_url", + "html_url", + "number", + "open_issues", + "state", + "title", + "url", + "created_at", + "updated_at" + ] + } + ] + }, + "locked": { + "type": "boolean" + }, + "active_lock_reason": { + "type": [ + "string", + "null" + ] + }, + "comments": { + "type": "integer" + }, + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "diff_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "patch_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "closed_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "body_html": { + "type": "string" + }, + "body_text": { + "type": "string" + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "type": "string" + } + } + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer", + "examples": [ + 5 + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + ] + }, + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ], + "examples": [ + "OWNER" + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + } + }, + "required": [ + "assignee", + "closed_at", + "comments", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "labels", + "labels_url", + "milestone", + "number", + "repository_url", + "state", + "locked", + "title", + "url", + "user", + "author_association", + "created_at", + "updated_at" + ] + } + } + } + } + ], + "previews": [], + "descriptionHTML": "

You can use the REST API to list the dependencies an issue is blocked by.

\n

This endpoint supports the following custom media types. For more information, see Media types.

\n", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "301", + "description": "

Moved permanently

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "410", + "description": "

Gone

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_by", + "title": "Add a dependency an issue is blocked by", + "category": "issues", + "subcategory": "issue-dependencies", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "issue_number", + "description": "

The number that identifies the issue.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [ + { + "type": "integer", + "name": "issue_id", + "in": "body", + "description": "

The id of the issue that blocks the current issue

", + "isRequired": true + } + ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Issues\" repository permissions": "write" + } + ], + "allowsPublicRead": true + }, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "issue_id": 1 + }, + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "issue_number": "ISSUE_NUMBER" + } + }, + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "

Response

", + "example": { + "id": 1, + "node_id": "MDU6SXNzdWUx", + "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", + "repository_url": "https://api.github.com/repos/octocat/Hello-World", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", + "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events", + "html_url": "https://github.com/octocat/Hello-World/issues/1347", + "number": 1347, + "state": "open", + "title": "Found a bug", + "body": "I'm having a problem with this.", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "labels": [ + { + "id": 208045946, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", + "name": "bug", + "description": "Something isn't working", + "color": "f29513", + "default": true + } + ], + "assignee": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "assignees": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + ], + "milestone": { + "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", + "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", + "id": 1002604, + "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", + "number": 1, + "state": "open", + "title": "v1.0", + "description": "Tracking milestone for version 1.0", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "open_issues": 4, + "closed_issues": 8, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z", + "closed_at": "2013-02-12T13:22:01Z", + "due_on": "2012-10-09T23:39:01Z" + }, + "locked": true, + "active_lock_reason": "too heated", + "comments": 0, + "pull_request": { + "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", + "html_url": "https://github.com/octocat/Hello-World/pull/1347", + "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", + "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch" + }, + "closed_at": null, + "created_at": "2011-04-22T13:33:48Z", + "updated_at": "2011-04-22T13:33:48Z", + "closed_by": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "author_association": "COLLABORATOR", + "state_reason": "completed" + }, + "schema": { + "title": "Issue", + "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repositories/42/issues/1" + ] + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "labels_url": { + "type": "string" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "number": { + "description": "Number uniquely identifying the issue within its repository", + "type": "integer", + "examples": [ + 42 + ] + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "examples": [ + "open" + ] + }, + "state_reason": { + "description": "The reason for the current state", + "type": [ + "string", + "null" + ], + "enum": [ + "completed", + "reopened", + "not_planned", + "duplicate", + null + ], + "examples": [ + "not_planned" + ] + }, + "title": { + "description": "Title of the issue", + "type": "string", + "examples": [ + "Widget creation fails in Safari on OS X 10.8" + ] + }, + "body": { + "description": "Contents of the issue", + "type": [ + "string", + "null" + ], + "examples": [ + "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?" + ] + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "labels": { + "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", + "type": "array", + "items": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "name": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "color": { + "type": [ + "string", + "null" + ] + }, + "default": { + "type": "boolean" + } + } + } + ] + }, + "examples": [ + "bug", + "registration" + ] + }, + "assignee": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "assignees": { + "type": [ + "array", + "null" + ], + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "milestone": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/milestones/v1.0" + ] + }, + "labels_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1002604 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDk6TWlsZXN0b25lMTAwMjYwNA==" + ] + }, + "number": { + "description": "The number of the milestone.", + "type": "integer", + "examples": [ + 42 + ] + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open", + "examples": [ + "open" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string", + "examples": [ + "v1.0" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "Tracking milestone for version 1.0" + ] + }, + "creator": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 4 + ] + }, + "closed_issues": { + "type": "integer", + "examples": [ + 8 + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-10T20:09:31Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2014-03-03T18:58:10Z" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2013-02-12T13:22:01Z" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2012-10-09T23:39:01Z" + ] + } + }, + "required": [ + "closed_issues", + "creator", + "description", + "due_on", + "closed_at", + "id", + "node_id", + "labels_url", + "html_url", + "number", + "open_issues", + "state", + "title", + "url", + "created_at", + "updated_at" + ] + } + ] + }, + "locked": { + "type": "boolean" + }, + "active_lock_reason": { + "type": [ + "string", + "null" + ] + }, + "comments": { + "type": "integer" + }, + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "diff_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "patch_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "closed_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "body_html": { + "type": "string" + }, + "body_text": { + "type": "string" + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "type": "string" + } + } + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer", + "examples": [ + 5 + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + ] + }, + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ], + "examples": [ + "OWNER" + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + } + }, + "required": [ + "assignee", + "closed_at", + "comments", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "labels", + "labels_url", + "milestone", + "number", + "repository_url", + "state", + "locked", + "title", + "url", + "user", + "author_association", + "created_at", + "updated_at" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "

You can use the REST API to add a 'blocked by' relationship to an issue.

\n

Creating content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see Rate limits for the API\nand Best practices for using the REST API.

\n

This endpoint supports the following custom media types. For more information, see Media types.

\n", + "statusCodes": [ + { + "httpStatusCode": "201", + "description": "

Created

" + }, + { + "httpStatusCode": "301", + "description": "

Moved permanently

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "410", + "description": "

Gone

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "delete", + "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_by/{issue_id}", + "title": "Remove dependency an issue is blocked by", + "category": "issues", + "subcategory": "issue-dependencies", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "issue_number", + "description": "

The number that identifies the issue.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "issue_id", + "in": "path", + "description": "

The id of the blocking issue to remove as a dependency

", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Issues\" repository permissions": "write" + } + ], + "allowsPublicRead": true + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "issue_number": "ISSUE_NUMBER", + "issue_id": "ISSUE_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "id": 1, + "node_id": "MDU6SXNzdWUx", + "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", + "repository_url": "https://api.github.com/repos/octocat/Hello-World", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", + "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events", + "html_url": "https://github.com/octocat/Hello-World/issues/1347", + "number": 1347, + "state": "open", + "title": "Found a bug", + "body": "I'm having a problem with this.", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "labels": [ + { + "id": 208045946, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", + "name": "bug", + "description": "Something isn't working", + "color": "f29513", + "default": true + } + ], + "assignee": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "assignees": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + ], + "milestone": { + "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", + "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", + "id": 1002604, + "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", + "number": 1, + "state": "open", + "title": "v1.0", + "description": "Tracking milestone for version 1.0", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "open_issues": 4, + "closed_issues": 8, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z", + "closed_at": "2013-02-12T13:22:01Z", + "due_on": "2012-10-09T23:39:01Z" + }, + "locked": true, + "active_lock_reason": "too heated", + "comments": 0, + "pull_request": { + "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", + "html_url": "https://github.com/octocat/Hello-World/pull/1347", + "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", + "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch" + }, + "closed_at": null, + "created_at": "2011-04-22T13:33:48Z", + "updated_at": "2011-04-22T13:33:48Z", + "closed_by": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "author_association": "COLLABORATOR", + "state_reason": "completed" + }, + "schema": { + "title": "Issue", + "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repositories/42/issues/1" + ] + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "labels_url": { + "type": "string" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "number": { + "description": "Number uniquely identifying the issue within its repository", + "type": "integer", + "examples": [ + 42 + ] + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "examples": [ + "open" + ] + }, + "state_reason": { + "description": "The reason for the current state", + "type": [ + "string", + "null" + ], + "enum": [ + "completed", + "reopened", + "not_planned", + "duplicate", + null + ], + "examples": [ + "not_planned" + ] + }, + "title": { + "description": "Title of the issue", + "type": "string", + "examples": [ + "Widget creation fails in Safari on OS X 10.8" + ] + }, + "body": { + "description": "Contents of the issue", + "type": [ + "string", + "null" + ], + "examples": [ + "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?" + ] + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "labels": { + "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", + "type": "array", + "items": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "name": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "color": { + "type": [ + "string", + "null" + ] + }, + "default": { + "type": "boolean" + } + } + } + ] + }, + "examples": [ + "bug", + "registration" + ] + }, + "assignee": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "assignees": { + "type": [ + "array", + "null" + ], + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "milestone": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/milestones/v1.0" + ] + }, + "labels_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1002604 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDk6TWlsZXN0b25lMTAwMjYwNA==" + ] + }, + "number": { + "description": "The number of the milestone.", + "type": "integer", + "examples": [ + 42 + ] + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open", + "examples": [ + "open" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string", + "examples": [ + "v1.0" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "Tracking milestone for version 1.0" + ] + }, + "creator": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 4 + ] + }, + "closed_issues": { + "type": "integer", + "examples": [ + 8 + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-10T20:09:31Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2014-03-03T18:58:10Z" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2013-02-12T13:22:01Z" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2012-10-09T23:39:01Z" + ] + } + }, + "required": [ + "closed_issues", + "creator", + "description", + "due_on", + "closed_at", + "id", + "node_id", + "labels_url", + "html_url", + "number", + "open_issues", + "state", + "title", + "url", + "created_at", + "updated_at" + ] + } + ] + }, + "locked": { + "type": "boolean" + }, + "active_lock_reason": { + "type": [ + "string", + "null" + ] + }, + "comments": { + "type": "integer" + }, + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "diff_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "patch_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "closed_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "body_html": { + "type": "string" + }, + "body_text": { + "type": "string" + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "type": "string" + } + } + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer", + "examples": [ + 5 + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + ] + }, + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ], + "examples": [ + "OWNER" + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + } + }, + "required": [ + "assignee", + "closed_at", + "comments", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "labels", + "labels_url", + "milestone", + "number", + "repository_url", + "state", + "locked", + "title", + "url", + "user", + "author_association", + "created_at", + "updated_at" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "

You can use the REST API to remove a dependency that an issue is blocked by.

\n

Removing content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see Rate limits for the API\nand Best practices for using the REST API.

\n

This endpoint supports the following custom media types. For more information, see Media types.

\n", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "301", + "description": "

Moved permanently

" + }, + { + "httpStatusCode": "400", + "description": "

Bad Request

" + }, + { + "httpStatusCode": "401", + "description": "

Requires authentication

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "410", + "description": "

Gone

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocking", + "title": "List dependencies an issue is blocking", + "category": "issues", + "subcategory": "issue-dependencies", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "issue_number", + "description": "

The number that identifies the issue.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "per_page", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Issues\" repository permissions": "read" + } + ], + "allowsPublicRead": true + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "issue_number": "ISSUE_NUMBER" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": [ + { + "id": 1, + "node_id": "MDU6SXNzdWUx", + "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", + "repository_url": "https://api.github.com/repos/octocat/Hello-World", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", + "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events", + "html_url": "https://github.com/octocat/Hello-World/issues/1347", + "number": 1347, + "state": "open", + "title": "Found a bug", + "body": "I'm having a problem with this.", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "labels": [ + { + "id": 208045946, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", + "name": "bug", + "description": "Something isn't working", + "color": "f29513", + "default": true + } + ], + "assignee": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "assignees": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + ], + "milestone": { + "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", + "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", + "id": 1002604, + "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", + "number": 1, + "state": "open", + "title": "v1.0", + "description": "Tracking milestone for version 1.0", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "open_issues": 4, + "closed_issues": 8, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z", + "closed_at": "2013-02-12T13:22:01Z", + "due_on": "2012-10-09T23:39:01Z" + }, + "locked": true, + "active_lock_reason": "too heated", + "comments": 0, + "pull_request": { + "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", + "html_url": "https://github.com/octocat/Hello-World/pull/1347", + "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", + "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch" + }, + "closed_at": null, + "created_at": "2011-04-22T13:33:48Z", + "updated_at": "2011-04-22T13:33:48Z", + "closed_by": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "author_association": "COLLABORATOR", + "state_reason": "completed" + } + ], + "schema": { + "type": "array", + "items": { + "title": "Issue", + "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repositories/42/issues/1" + ] + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "labels_url": { + "type": "string" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "number": { + "description": "Number uniquely identifying the issue within its repository", + "type": "integer", + "examples": [ + 42 + ] + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "examples": [ + "open" + ] + }, + "state_reason": { + "description": "The reason for the current state", + "type": [ + "string", + "null" + ], + "enum": [ + "completed", + "reopened", + "not_planned", + "duplicate", + null + ], + "examples": [ + "not_planned" + ] + }, + "title": { + "description": "Title of the issue", + "type": "string", + "examples": [ + "Widget creation fails in Safari on OS X 10.8" + ] + }, + "body": { + "description": "Contents of the issue", + "type": [ + "string", + "null" + ], + "examples": [ + "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?" + ] + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "labels": { + "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", + "type": "array", + "items": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "name": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "color": { + "type": [ + "string", + "null" + ] + }, + "default": { + "type": "boolean" + } + } + } + ] + }, + "examples": [ + "bug", + "registration" + ] + }, + "assignee": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "assignees": { + "type": [ + "array", + "null" + ], + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "milestone": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/milestones/v1.0" + ] + }, + "labels_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1002604 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDk6TWlsZXN0b25lMTAwMjYwNA==" + ] + }, + "number": { + "description": "The number of the milestone.", + "type": "integer", + "examples": [ + 42 + ] + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open", + "examples": [ + "open" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string", + "examples": [ + "v1.0" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "Tracking milestone for version 1.0" + ] + }, + "creator": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 4 + ] + }, + "closed_issues": { + "type": "integer", + "examples": [ + 8 + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-10T20:09:31Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2014-03-03T18:58:10Z" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2013-02-12T13:22:01Z" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2012-10-09T23:39:01Z" + ] + } + }, + "required": [ + "closed_issues", + "creator", + "description", + "due_on", + "closed_at", + "id", + "node_id", + "labels_url", + "html_url", + "number", + "open_issues", + "state", + "title", + "url", + "created_at", + "updated_at" + ] + } + ] + }, + "locked": { + "type": "boolean" + }, + "active_lock_reason": { + "type": [ + "string", + "null" + ] + }, + "comments": { + "type": "integer" + }, + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "diff_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "patch_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "closed_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "body_html": { + "type": "string" + }, + "body_text": { + "type": "string" + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "type": "string" + } + } + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer", + "examples": [ + 5 + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + ] + }, + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ], + "examples": [ + "OWNER" + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" } }, "required": [ - "id", - "node_id", "url", - "actor", - "event", - "commit_id", - "commit_url", - "created_at", - "performed_via_github_app" + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" ] } + }, + "required": [ + "assignee", + "closed_at", + "comments", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "labels", + "labels_url", + "milestone", + "number", + "repository_url", + "state", + "locked", + "title", + "url", + "user", + "author_association", + "created_at", + "updated_at" ] } } @@ -339190,12 +354614,20 @@ } ], "previews": [], - "descriptionHTML": "

Lists all events for an issue.

", + "descriptionHTML": "

You can use the REST API to list the dependencies an issue is blocking.

\n

This endpoint supports the following custom media types. For more information, see Media types.

\n", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" }, + { + "httpStatusCode": "301", + "description": "

Moved permanently

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, { "httpStatusCode": "410", "description": "

Gone

" @@ -342897,13 +358329,13 @@ } ], "previews": [], + "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "" + ] }, { "serverUrl": "https://api.github.com", @@ -345973,6 +361405,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -349015,6 +364471,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -352053,6 +367533,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -355105,6 +370609,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -368644,6 +384172,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -373676,6 +389228,7 @@ } ], "previews": [], + "descriptionHTML": "

Returns meta information about GitHub, including a list of GitHub's IP addresses. For more information, see \"About GitHub's IP addresses.\"

\n

The API's response also includes a list of GitHub's domain names.

\n

The values shown in the documentation's response are example values. You must always query the API directly to get the latest values.

\n

Note

\n

\nThis endpoint returns both IPv4 and IPv6 addresses. However, not all features support IPv6. You should refer to the specific documentation for each feature to determine if IPv6 is supported.

\n
", "statusCodes": [ { "httpStatusCode": "200", @@ -373685,8 +389238,7 @@ "httpStatusCode": "304", "description": "

Not modified

" } - ], - "descriptionHTML": "

Returns meta information about GitHub, including a list of GitHub's IP addresses. For more information, see \"About GitHub's IP addresses.\"

\n

The API's response also includes a list of GitHub's domain names.

\n

The values shown in the documentation's response are example values. You must always query the API directly to get the latest values.

\n

Note

\n

\nThis endpoint returns both IPv4 and IPv6 addresses. However, not all features support IPv6. You should refer to the specific documentation for each feature to determine if IPv6 is supported.

\n
" + ] }, { "serverUrl": "https://api.github.com", @@ -373734,13 +389286,13 @@ } ], "previews": [], + "descriptionHTML": "

Get the octocat as ASCII art

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Get the octocat as ASCII art

" + ] }, { "serverUrl": "https://api.github.com", @@ -392101,6 +407653,7 @@ } ], "previews": [], + "descriptionHTML": "

Deletes an organization and all its repositories.

\n

The organization login will be unavailable for 90 days after deletion.

\n

Please review the Terms of Service regarding account deletion before using this endpoint:

\n

https://docs.github.com/site-policy/github-terms/github-terms-of-service

", "statusCodes": [ { "httpStatusCode": "202", @@ -392114,8 +407667,7 @@ "httpStatusCode": "404", "description": "

Resource not found

" } - ], - "descriptionHTML": "

Deletes an organization and all its repositories.

\n

The organization login will be unavailable for 90 days after deletion.

\n

Please review the Terms of Service regarding account deletion before using this endpoint:

\n

https://docs.github.com/site-policy/github-terms/github-terms-of-service

" + ] }, { "serverUrl": "https://api.github.com", @@ -394487,13 +410039,13 @@ } ], "previews": [], + "descriptionHTML": "

Get API request count statistics for an actor broken down by route within a specified time frame.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Get API request count statistics for an actor broken down by route within a specified time frame.

" + ] }, { "serverUrl": "https://api.github.com", @@ -394762,13 +410314,13 @@ } ], "previews": [], + "descriptionHTML": "

Get overall statistics of API requests made within an organization by all users and apps within a specified time frame.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Get overall statistics of API requests made within an organization by all users and apps within a specified time frame.

" + ] }, { "serverUrl": "https://api.github.com", @@ -396334,13 +411886,13 @@ } ], "previews": [], + "descriptionHTML": "

Unblocks the given user on behalf of the specified organization.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "descriptionHTML": "

Unblocks the given user on behalf of the specified organization.

" + ] } ], "custom-properties": [ @@ -401539,6 +417091,7 @@ } ], "previews": [], + "descriptionHTML": "

Check if the provided user is a public member of the organization.

", "statusCodes": [ { "httpStatusCode": "204", @@ -401548,8 +417101,7 @@ "httpStatusCode": "404", "description": "

Not Found if user is not a public member

" } - ], - "descriptionHTML": "

Check if the provided user is a public member of the organization.

" + ] }, { "serverUrl": "https://api.github.com", @@ -403311,13 +418863,13 @@ } ], "previews": [], + "descriptionHTML": "

Lists all hosted compute network configurations configured in an organization.

\n

OAuth app tokens and personal access tokens (classic) need the read:network_configurations scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Lists all hosted compute network configurations configured in an organization.

\n

OAuth app tokens and personal access tokens (classic) need the read:network_configurations scope to use this endpoint.

" + ] }, { "serverUrl": "https://api.github.com", @@ -404403,13 +419955,13 @@ } ], "previews": [], + "descriptionHTML": "

Removes all assigned organization roles from a team. For more information on organization roles, see \"Using organization roles.\"

\n

The authenticated user must be an administrator for the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "descriptionHTML": "

Removes all assigned organization roles from a team. For more information on organization roles, see \"Using organization roles.\"

\n

The authenticated user must be an administrator for the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" + ] }, { "serverUrl": "https://api.github.com", @@ -404559,13 +420111,13 @@ } ], "previews": [], + "descriptionHTML": "

Removes an organization role from a team. For more information on organization roles, see \"Using organization roles.\"

\n

The authenticated user must be an administrator for the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "descriptionHTML": "

Removes an organization role from a team. For more information on organization roles, see \"Using organization roles.\"

\n

The authenticated user must be an administrator for the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" + ] }, { "serverUrl": "https://api.github.com", @@ -405867,6 +421419,7 @@ } ], "previews": [], + "descriptionHTML": "

Lists organization members that are assigned to an organization role. For more information on organization roles, see \"Using organization roles.\"

\n

To use this endpoint, you must be an administrator for the organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -405880,8 +421433,7 @@ "httpStatusCode": "422", "description": "

Response if the organization roles feature is not enabled or validation failed.

" } - ], - "descriptionHTML": "

Lists organization members that are assigned to an organization role. For more information on organization roles, see \"Using organization roles.\"

\n

To use this endpoint, you must be an administrator for the organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" + ] } ], "outside-collaborators": [ @@ -420110,13 +435662,13 @@ } ], "previews": [], + "descriptionHTML": "

Updates the webhook configuration for an organization. To update more information about the webhook, including the active state and events, use \"Update an organization webhook .\"

\n

You must be an organization owner to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need admin:org_hook scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Updates the webhook configuration for an organization. To update more information about the webhook, including the active state and events, use \"Update an organization webhook .\"

\n

You must be an organization owner to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need admin:org_hook scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.

" + ] }, { "serverUrl": "https://api.github.com", @@ -425305,13 +440857,13 @@ } ], "previews": [], + "descriptionHTML": "

Gets a specific package version in an organization.

\n

OAuth app tokens and personal access tokens (classic) need the read:packages scope to use this endpoint. For more information, see \"About permissions for GitHub Packages.\"

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Gets a specific package version in an organization.

\n

OAuth app tokens and personal access tokens (classic) need the read:packages scope to use this endpoint. For more information, see \"About permissions for GitHub Packages.\"

" + ] }, { "serverUrl": "https://api.github.com", @@ -436059,13 +451611,13 @@ } ], "previews": [], + "descriptionHTML": "

Lists builts of a GitHub Pages site.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Lists builts of a GitHub Pages site.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" + ] }, { "serverUrl": "https://api.github.com", @@ -487192,13 +502744,13 @@ } ], "previews": [], + "descriptionHTML": "

Note

\n

\nYou can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id.

\n
\n

Delete a reaction to a team discussion.

\n

OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "descriptionHTML": "

Note

\n

\nYou can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id.

\n
\n

Delete a reaction to a team discussion.

\n

OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.

" + ] }, { "serverUrl": "https://api.github.com", @@ -488650,6 +504202,7 @@ } ], "previews": [], + "descriptionHTML": "

List the reactions to an issue comment.

", "statusCodes": [ { "httpStatusCode": "200", @@ -488659,8 +504212,7 @@ "httpStatusCode": "404", "description": "

Resource not found

" } - ], - "descriptionHTML": "

List the reactions to an issue comment.

" + ] }, { "serverUrl": "https://api.github.com", @@ -559715,6 +575267,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "type": "string" }, @@ -572505,6 +588081,435 @@ } ] } + ], + "push-protection": [ + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/secret-scanning/pattern-configurations", + "title": "List organization pattern configurations", + "category": "secret-scanning", + "subcategory": "push-protection", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Administration\" organization permissions": "write" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "pattern_config_version": "0ujsswThIGTUYm2K8FjOOfXtY1K", + "provider_pattern_overrides": [ + { + "token_type": "GITHUB_PERSONAL_ACCESS_TOKEN", + "slug": "github_personal_access_token_legacy_v2", + "display_name": "GitHub Personal Access Token (Legacy v2)", + "alert_total": 15, + "alert_total_percentage": 36, + "false_positives": 2, + "false_positive_rate": 13, + "bypass_rate": 13, + "default_setting": "enabled", + "setting": "enabled", + "enterprise_setting": "enabled" + } + ], + "custom_pattern_overrides": [ + { + "token_type": "cp_2", + "custom_pattern_version": "0ujsswThIGTUYm2K8FjOOfXtY1K", + "slug": "custom-api-key", + "display_name": "Custom API Key", + "alert_total": 15, + "alert_total_percentage": 36, + "false_positives": 3, + "false_positive_rate": 20, + "bypass_rate": 20, + "default_setting": "disabled", + "setting": "enabled" + } + ] + }, + "schema": { + "title": "Secret scanning pattern configuration", + "description": "A collection of secret scanning patterns and their settings related to push protection.", + "type": "object", + "properties": { + "pattern_config_version": { + "type": [ + "string", + "null" + ], + "description": "The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate unintentionally overriding someone else's update." + }, + "provider_pattern_overrides": { + "type": "array", + "description": "Overrides for partner patterns.", + "items": { + "type": "object", + "properties": { + "token_type": { + "type": "string", + "description": "The ID of the pattern." + }, + "custom_pattern_version": { + "type": [ + "string", + "null" + ], + "description": "The version of this pattern if it's a custom pattern." + }, + "slug": { + "type": "string", + "description": "The slug of the pattern." + }, + "display_name": { + "type": "string", + "description": "The user-friendly name for the pattern." + }, + "alert_total": { + "type": "integer", + "description": "The total number of alerts generated by this pattern." + }, + "alert_total_percentage": { + "type": "integer", + "description": "The percentage of all alerts that this pattern represents, rounded to the nearest integer." + }, + "false_positives": { + "type": "integer", + "description": "The number of false positive alerts generated by this pattern." + }, + "false_positive_rate": { + "type": "integer", + "description": "The percentage of alerts from this pattern that are false positives, rounded to the nearest integer." + }, + "bypass_rate": { + "type": "integer", + "description": "The percentage of blocks for this pattern that were bypassed, rounded to the nearest integer." + }, + "default_setting": { + "type": "string", + "description": "The default push protection setting for this pattern.", + "enum": [ + "disabled", + "enabled" + ] + }, + "enterprise_setting": { + "type": [ + "string", + "null" + ], + "description": "The push protection setting for this pattern set at the enterprise level. Only present for partner patterns when the organization has a parent enterprise.", + "enum": [ + "not-set", + "disabled", + "enabled", + null + ] + }, + "setting": { + "type": "string", + "description": "The current push protection setting for this pattern. If this is `not-set`, then it inherits either the enterprise setting if it exists or the default setting.", + "enum": [ + "not-set", + "disabled", + "enabled" + ] + } + } + } + }, + "custom_pattern_overrides": { + "type": "array", + "description": "Overrides for custom patterns defined by the organization.", + "items": { + "type": "object", + "properties": { + "token_type": { + "type": "string", + "description": "The ID of the pattern." + }, + "custom_pattern_version": { + "type": [ + "string", + "null" + ], + "description": "The version of this pattern if it's a custom pattern." + }, + "slug": { + "type": "string", + "description": "The slug of the pattern." + }, + "display_name": { + "type": "string", + "description": "The user-friendly name for the pattern." + }, + "alert_total": { + "type": "integer", + "description": "The total number of alerts generated by this pattern." + }, + "alert_total_percentage": { + "type": "integer", + "description": "The percentage of all alerts that this pattern represents, rounded to the nearest integer." + }, + "false_positives": { + "type": "integer", + "description": "The number of false positive alerts generated by this pattern." + }, + "false_positive_rate": { + "type": "integer", + "description": "The percentage of alerts from this pattern that are false positives, rounded to the nearest integer." + }, + "bypass_rate": { + "type": "integer", + "description": "The percentage of blocks for this pattern that were bypassed, rounded to the nearest integer." + }, + "default_setting": { + "type": "string", + "description": "The default push protection setting for this pattern.", + "enum": [ + "disabled", + "enabled" + ] + }, + "enterprise_setting": { + "type": [ + "string", + "null" + ], + "description": "The push protection setting for this pattern set at the enterprise level. Only present for partner patterns when the organization has a parent enterprise.", + "enum": [ + "not-set", + "disabled", + "enabled", + null + ] + }, + "setting": { + "type": "string", + "description": "The current push protection setting for this pattern. If this is `not-set`, then it inherits either the enterprise setting if it exists or the default setting.", + "enum": [ + "not-set", + "disabled", + "enabled" + ] + } + } + } + } + } + } + } + } + ], + "previews": [], + "descriptionHTML": "

Lists the secret scanning pattern configurations for an organization.

\n

Personal access tokens (classic) need the write:org scope to use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "patch", + "requestPath": "/orgs/{org}/secret-scanning/pattern-configurations", + "title": "Update organization pattern configurations", + "category": "secret-scanning", + "subcategory": "push-protection", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "string or null", + "name": "pattern_config_version", + "in": "body", + "description": "

The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate unintentionally overriding someone else's update.

" + }, + { + "type": "array of objects", + "name": "provider_pattern_settings", + "in": "body", + "description": "

Pattern settings for provider patterns.

", + "childParamsGroups": [ + { + "type": "string", + "name": "token_type", + "description": "

The ID of the pattern to configure.

" + }, + { + "type": "string", + "name": "push_protection_setting", + "description": "

Push protection setting to set for the pattern.

", + "enum": [ + "not-set", + "disabled", + "enabled" + ] + } + ] + }, + { + "type": "array of objects", + "name": "custom_pattern_settings", + "in": "body", + "description": "

Pattern settings for custom patterns.

", + "childParamsGroups": [ + { + "type": "string", + "name": "token_type", + "description": "

The ID of the pattern to configure.

" + }, + { + "type": "string or null", + "name": "custom_pattern_version", + "description": "

The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate unintentionally overriding someone else's update.

" + }, + { + "type": "string", + "name": "push_protection_setting", + "description": "

Push protection setting to set for the pattern.

", + "enum": [ + "disabled", + "enabled" + ] + } + ] + } + ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Administration\" organization permissions": "write" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "pattern_config_version": "0ujsswThIGTUYm2K8FjOOfXtY1K", + "provider_pattern_settings": [ + { + "token_type": "GITHUB_PERSONAL_ACCESS_TOKEN", + "push_protection_setting": "enabled" + } + ], + "custom_pattern_settings": [ + { + "token_type": "cp_2", + "custom_pattern_version": "0ujsswThIGTUYm2K8FjOOfXtY1K", + "push_protection_setting": "enabled" + } + ] + }, + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "pattern_config_version": "0ujsswThIGTUYm2K8FjOOfXtY1K" + }, + "schema": { + "type": "object", + "properties": { + "pattern_config_version": { + "type": "string", + "description": "The updated pattern configuration version." + } + } + } + } + } + ], + "previews": [], + "descriptionHTML": "

Updates the secret scanning pattern configurations for an organization.

\n

Personal access tokens (classic) need the write:org scope to use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "400", + "description": "

Bad Request

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "409", + "description": "

Conflict

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + } + ] + } ] }, "security-advisories": { @@ -596903,6 +612908,7 @@ } ], "previews": [], + "descriptionHTML": "

To create a team, the authenticated user must be a member or owner of {org}. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see \"Setting team creation permissions.\"

\n

When you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of maintainers. For more information, see \"About teams\".

", "statusCodes": [ { "httpStatusCode": "201", @@ -596916,8 +612922,7 @@ "httpStatusCode": "422", "description": "

Validation failed, or the endpoint has been spammed.

" } - ], - "descriptionHTML": "

To create a team, the authenticated user must be a member or owner of {org}. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see \"Setting team creation permissions.\"

\n

When you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of maintainers. For more information, see \"About teams\".

" + ] }, { "serverUrl": "https://api.github.com", @@ -602580,13 +618585,13 @@ } ], "previews": [], + "descriptionHTML": "

If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team.

\n

Note

\n

\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}.

\n
", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "descriptionHTML": "

If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team.

\n

Note

\n

\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}.

\n
" + ] }, { "serverUrl": "https://api.github.com", @@ -602906,13 +618911,13 @@ } ], "previews": [], + "descriptionHTML": "

Lists the child teams of the team specified by {team_slug}.

\n

Note

\n

\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/teams.

\n
", "statusCodes": [ { "httpStatusCode": "200", "description": "

if child teams exist

" } - ], - "descriptionHTML": "

Lists the child teams of the team specified by {team_slug}.

\n

Note

\n

\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/teams.

\n
" + ] }, { "serverUrl": "https://api.github.com", @@ -613890,13 +629895,13 @@ } ], "previews": [], + "descriptionHTML": "

List all discussions on a team's page.

\n

Note

\n

\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions.

\n
\n

OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

List all discussions on a team's page.

\n

Note

\n

\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions.

\n
\n

OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.

" + ] }, { "serverUrl": "https://api.github.com", diff --git a/src/rest/data/ghec-2022-11-28/schema.json b/src/rest/data/ghec-2022-11-28/schema.json index 0a93fb72bc2a..928c77f4995c 100644 --- a/src/rest/data/ghec-2022-11-28/schema.json +++ b/src/rest/data/ghec-2022-11-28/schema.json @@ -2759,13 +2759,13 @@ } ], "previews": [], - "descriptionHTML": "

Get the list of partner images available for GitHub-hosted runners for an enterprise.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Get the list of partner images available for GitHub-hosted runners for an enterprise.

" }, { "serverUrl": "https://api.github.com", @@ -6283,13 +6283,13 @@ } ], "previews": [], - "descriptionHTML": "

Gets the customization template for an OpenID Connect (OIDC) subject claim.

\n

OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

A JSON serialized template for OIDC subject claim customization

" } - ] + ], + "descriptionHTML": "

Gets the customization template for an OpenID Connect (OIDC) subject claim.

\n

OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.

" }, { "serverUrl": "https://api.github.com", @@ -6760,8 +6760,8 @@ { "serverUrl": "https://api.github.com", "verb": "get", - "requestPath": "/enterprises/{enterprise}/actions/permissions/organizations", - "title": "List selected organizations enabled for GitHub Actions in an enterprise", + "requestPath": "/enterprises/{enterprise}/actions/permissions/artifact-and-log-retention", + "title": "Get artifact and log retention settings for an enterprise", "category": "actions", "subcategory": "permissions", "parameters": [ @@ -6773,24 +6773,6 @@ "schema": { "type": "string" } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } } ], "bodyParameters": [], @@ -6813,157 +6795,53 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "

Response

", + "description": "

Example response

", "example": { - "total_count": 1, - "organizations": [ - { - "login": "octocat", - "id": 161335, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "url": "https://api.github.com/orgs/octo-org", - "repos_url": "https://api.github.com/orgs/octo-org/repos", - "events_url": "https://api.github.com/orgs/octo-org/events", - "hooks_url": "https://api.github.com/orgs/octo-org/hooks", - "issues_url": "https://api.github.com/orgs/octo-org/issues", - "members_url": "https://api.github.com/orgs/octo-org/members{/member}", - "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization" - } - ] + "days": 90, + "maximum_allowed_days": 365 }, "schema": { "type": "object", "properties": { - "total_count": { - "type": "number" + "days": { + "type": "integer", + "description": "The number of days artifacts and logs are retained" }, - "organizations": { - "type": "array", - "items": { - "title": "Organization Simple", - "description": "A GitHub organization.", - "type": "object", - "properties": { - "login": { - "type": "string", - "examples": [ - "github" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/repos" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/events" - ] - }, - "hooks_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/hooks" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/issues" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/members{/member}" - ] - }, - "public_members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" - ] - }, - "avatar_url": { - "type": "string", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great organization" - ] - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ] - } + "maximum_allowed_days": { + "type": "integer", + "description": "The maximum number of days that can be configured" } }, "required": [ - "total_count", - "organizations" + "days", + "maximum_allowed_days" ] } } } ], "previews": [], - "descriptionHTML": "

Lists the organizations that are selected to have GitHub Actions enabled in an enterprise. To use this endpoint, the enterprise permission policy for enabled_organizations must be configured to selected. For more information, see \"Set GitHub Actions permissions for an enterprise.\"

\n

OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

", + "descriptionHTML": "

Gets artifact and log retention settings for an enterprise.

", "statusCodes": [ { "httpStatusCode": "200", - "description": "

OK

" + "description": "

Successfully retrieved the artifact and log retention settings

" + }, + { + "httpStatusCode": "401", + "description": "

Authorization failure

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", - "requestPath": "/enterprises/{enterprise}/actions/permissions/organizations", - "title": "Set selected organizations enabled for GitHub Actions in an enterprise", + "requestPath": "/enterprises/{enterprise}/actions/permissions/artifact-and-log-retention", + "title": "Set artifact and log retention settings for an enterprise", "category": "actions", "subcategory": "permissions", "parameters": [ @@ -6979,10 +6857,10 @@ ], "bodyParameters": [ { - "type": "array of integers", - "name": "selected_organization_ids", + "type": "integer", + "name": "days", "in": "body", - "description": "

List of organization IDs to enable for GitHub Actions.

", + "description": "

The number of days to retain artifacts and logs

", "isRequired": true } ], @@ -6997,13 +6875,10 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Set retention to 100 days", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "selected_organization_ids": [ - 32, - 91 - ] + "days": 100 }, "parameters": { "enterprise": "ENTERPRISE" @@ -7011,24 +6886,32 @@ }, "response": { "statusCode": "204", - "description": "

Response

" + "description": "

Successfully updated the artifact and log retention settings

" } } ], "previews": [], - "descriptionHTML": "

Replaces the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for enabled_organizations must be configured to selected. For more information, see \"Set GitHub Actions permissions for an enterprise.\"

\n

OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

", + "descriptionHTML": "

Sets artifact and log retention settings for an enterprise.

", "statusCodes": [ { "httpStatusCode": "204", - "description": "

No Content

" + "description": "

Successfully updated the artifact and log retention settings

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" } ] }, { "serverUrl": "https://api.github.com", - "verb": "put", - "requestPath": "/enterprises/{enterprise}/actions/permissions/organizations/{org_id}", - "title": "Enable a selected organization for GitHub Actions in an enterprise", + "verb": "get", + "requestPath": "/enterprises/{enterprise}/actions/permissions/fork-pr-contributor-approval", + "title": "Get fork PR contributor approval permissions for an enterprise", "category": "actions", "subcategory": "permissions", "parameters": [ @@ -7040,15 +6923,6 @@ "schema": { "type": "string" } - }, - { - "name": "org_id", - "description": "

The unique identifier of the organization.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "bodyParameters": [], @@ -7065,30 +6939,54 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "enterprise": "ENTERPRISE", - "org_id": "ORG_ID" + "enterprise": "ENTERPRISE" } }, "response": { - "statusCode": "204", - "description": "

Response

" + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "approval_policy": "first_time_contributors" + }, + "schema": { + "type": "object", + "properties": { + "approval_policy": { + "type": "string", + "enum": [ + "first_time_contributors_new_to_github", + "first_time_contributors", + "all_external_contributors" + ], + "description": "The policy that controls when fork PR workflows require approval from a maintainer." + } + }, + "required": [ + "approval_policy" + ] + } } } ], "previews": [], - "descriptionHTML": "

Adds an organization to the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for enabled_organizations must be configured to selected. For more information, see \"Set GitHub Actions permissions for an enterprise.\"

\n

OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

", + "descriptionHTML": "

Gets the fork PR contributor approval policy for an enterprise.

", "statusCodes": [ { - "httpStatusCode": "204", - "description": "

No Content

" + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" } ] }, { "serverUrl": "https://api.github.com", - "verb": "delete", - "requestPath": "/enterprises/{enterprise}/actions/permissions/organizations/{org_id}", - "title": "Disable a selected organization for GitHub Actions in an enterprise", + "verb": "put", + "requestPath": "/enterprises/{enterprise}/actions/permissions/fork-pr-contributor-approval", + "title": "Set fork PR contributor approval permissions for an enterprise", "category": "actions", "subcategory": "permissions", "parameters": [ @@ -7100,18 +6998,22 @@ "schema": { "type": "string" } - }, + } + ], + "bodyParameters": [ { - "name": "org_id", - "description": "

The unique identifier of the organization.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } + "type": "string", + "name": "approval_policy", + "in": "body", + "description": "

The policy that controls when fork PR workflows require approval from a maintainer.

", + "isRequired": true, + "enum": [ + "first_time_contributors_new_to_github", + "first_time_contributors", + "all_external_contributors" + ] } ], - "bodyParameters": [], "progAccess": { "userToServerRest": false, "serverToServer": false, @@ -7122,11 +7024,14 @@ { "key": "default", "request": { - "description": "Example", + "contentType": "application/json", + "description": "Set approval policy to first time contributors", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "approval_policy": "first_time_contributors" + }, "parameters": { - "enterprise": "ENTERPRISE", - "org_id": "ORG_ID" + "enterprise": "ENTERPRISE" } }, "response": { @@ -7136,19 +7041,593 @@ } ], "previews": [], - "descriptionHTML": "

Removes an organization from the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for enabled_organizations must be configured to selected. For more information, see \"Set GitHub Actions permissions for an enterprise.\"

\n

OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

", + "descriptionHTML": "

Sets the fork PR contributor approval policy for an enterprise.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", - "requestPath": "/enterprises/{enterprise}/actions/permissions/selected-actions", - "title": "Get allowed actions and reusable workflows for an enterprise", + "requestPath": "/enterprises/{enterprise}/actions/permissions/fork-pr-workflows-private-repos", + "title": "Get private repo fork PR workflow settings for an enterprise", + "category": "actions", + "subcategory": "permissions", + "parameters": [ + { + "name": "enterprise", + "description": "

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "enterprise": "ENTERPRISE" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "run_workflows_from_fork_pull_requests": true, + "send_write_tokens_to_workflows": false, + "send_secrets_and_variables": false, + "require_approval_for_fork_pr_workflows": true + }, + "schema": { + "type": "object", + "required": [ + "run_workflows_from_fork_pull_requests", + "send_write_tokens_to_workflows", + "send_secrets_and_variables", + "require_approval_for_fork_pr_workflows" + ], + "properties": { + "run_workflows_from_fork_pull_requests": { + "type": "boolean", + "description": "Whether workflows triggered by pull requests from forks are allowed to run on private repositories." + }, + "send_write_tokens_to_workflows": { + "type": "boolean", + "description": "Whether GitHub Actions can create pull requests or submit approving pull request reviews from a workflow triggered by a fork pull request." + }, + "send_secrets_and_variables": { + "type": "boolean", + "description": "Whether to make secrets and variables available to workflows triggered by pull requests from forks." + }, + "require_approval_for_fork_pr_workflows": { + "type": "boolean", + "description": "Whether workflows triggered by pull requests from forks require approval from a repository administrator to run." + } + } + } + } + } + ], + "previews": [], + "descriptionHTML": "

Gets the settings for whether workflows from fork pull requests can run on private repositories in an enterprise.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/enterprises/{enterprise}/actions/permissions/fork-pr-workflows-private-repos", + "title": "Set private repo fork PR workflow settings for an enterprise", + "category": "actions", + "subcategory": "permissions", + "parameters": [ + { + "name": "enterprise", + "description": "

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "boolean", + "name": "run_workflows_from_fork_pull_requests", + "in": "body", + "description": "

Whether workflows triggered by pull requests from forks are allowed to run on private repositories.

", + "isRequired": true + }, + { + "type": "boolean", + "name": "send_write_tokens_to_workflows", + "in": "body", + "description": "

Whether GitHub Actions can create pull requests or submit approving pull request reviews from a workflow triggered by a fork pull request.

" + }, + { + "type": "boolean", + "name": "send_secrets_and_variables", + "in": "body", + "description": "

Whether to make secrets and variables available to workflows triggered by pull requests from forks.

" + }, + { + "type": "boolean", + "name": "require_approval_for_fork_pr_workflows", + "in": "body", + "description": "

Whether workflows triggered by pull requests from forks require approval from a repository administrator to run.

" + } + ], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "run_workflows_from_fork_pull_requests": true, + "send_write_tokens_to_workflows": false, + "send_secrets_and_variables": false, + "require_approval_for_fork_pr_workflows": true + }, + "parameters": { + "enterprise": "ENTERPRISE" + } + }, + "response": { + "statusCode": "204", + "description": "

Empty response for successful settings update

" + } + } + ], + "previews": [], + "descriptionHTML": "

Sets the settings for whether workflows from fork pull requests can run on private repositories in an enterprise.

", + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "

Empty response for successful settings update

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/enterprises/{enterprise}/actions/permissions/organizations", + "title": "List selected organizations enabled for GitHub Actions in an enterprise", + "category": "actions", + "subcategory": "permissions", + "parameters": [ + { + "name": "enterprise", + "description": "

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "enterprise": "ENTERPRISE" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "total_count": 1, + "organizations": [ + { + "login": "octocat", + "id": 161335, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "url": "https://api.github.com/orgs/octo-org", + "repos_url": "https://api.github.com/orgs/octo-org/repos", + "events_url": "https://api.github.com/orgs/octo-org/events", + "hooks_url": "https://api.github.com/orgs/octo-org/hooks", + "issues_url": "https://api.github.com/orgs/octo-org/issues", + "members_url": "https://api.github.com/orgs/octo-org/members{/member}", + "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + } + ] + }, + "schema": { + "type": "object", + "properties": { + "total_count": { + "type": "number" + }, + "organizations": { + "type": "array", + "items": { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + } + } + }, + "required": [ + "total_count", + "organizations" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "

Lists the organizations that are selected to have GitHub Actions enabled in an enterprise. To use this endpoint, the enterprise permission policy for enabled_organizations must be configured to selected. For more information, see \"Set GitHub Actions permissions for an enterprise.\"

\n

OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/enterprises/{enterprise}/actions/permissions/organizations", + "title": "Set selected organizations enabled for GitHub Actions in an enterprise", + "category": "actions", + "subcategory": "permissions", + "parameters": [ + { + "name": "enterprise", + "description": "

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "array of integers", + "name": "selected_organization_ids", + "in": "body", + "description": "

List of organization IDs to enable for GitHub Actions.

", + "isRequired": true + } + ], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "selected_organization_ids": [ + 32, + 91 + ] + }, + "parameters": { + "enterprise": "ENTERPRISE" + } + }, + "response": { + "statusCode": "204", + "description": "

Response

" + } + } + ], + "previews": [], + "descriptionHTML": "

Replaces the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for enabled_organizations must be configured to selected. For more information, see \"Set GitHub Actions permissions for an enterprise.\"

\n

OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "

No Content

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/enterprises/{enterprise}/actions/permissions/organizations/{org_id}", + "title": "Enable a selected organization for GitHub Actions in an enterprise", + "category": "actions", + "subcategory": "permissions", + "parameters": [ + { + "name": "enterprise", + "description": "

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "org_id", + "description": "

The unique identifier of the organization.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "enterprise": "ENTERPRISE", + "org_id": "ORG_ID" + } + }, + "response": { + "statusCode": "204", + "description": "

Response

" + } + } + ], + "previews": [], + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "

No Content

" + } + ], + "descriptionHTML": "

Adds an organization to the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for enabled_organizations must be configured to selected. For more information, see \"Set GitHub Actions permissions for an enterprise.\"

\n

OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

" + }, + { + "serverUrl": "https://api.github.com", + "verb": "delete", + "requestPath": "/enterprises/{enterprise}/actions/permissions/organizations/{org_id}", + "title": "Disable a selected organization for GitHub Actions in an enterprise", + "category": "actions", + "subcategory": "permissions", + "parameters": [ + { + "name": "enterprise", + "description": "

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "org_id", + "description": "

The unique identifier of the organization.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "enterprise": "ENTERPRISE", + "org_id": "ORG_ID" + } + }, + "response": { + "statusCode": "204", + "description": "

Response

" + } + } + ], + "previews": [], + "descriptionHTML": "

Removes an organization from the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for enabled_organizations must be configured to selected. For more information, see \"Set GitHub Actions permissions for an enterprise.\"

\n

OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "

No Content

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/enterprises/{enterprise}/actions/permissions/selected-actions", + "title": "Get allowed actions and reusable workflows for an enterprise", "category": "actions", "subcategory": "permissions", "parameters": [ @@ -7301,6 +7780,146 @@ } ] }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/enterprises/{enterprise}/actions/permissions/self-hosted-runners", + "title": "Get self-hosted runners permissions for an enterprise", + "category": "actions", + "subcategory": "permissions", + "parameters": [ + { + "name": "enterprise", + "description": "

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "enterprise": "ENTERPRISE" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "disable_self_hosted_runners_for_all_orgs": false + }, + "schema": { + "type": "object", + "properties": { + "disable_self_hosted_runners_for_all_orgs": { + "type": "boolean", + "description": "When true, repository-level runners will be disabled across all organizations in the enterprise" + } + }, + "required": [ + "disable_self_hosted_runners_for_all_orgs" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "

Gets the settings for whether organizations in the enterprise are allowed to manage self-hosted runners at the repository level.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/enterprises/{enterprise}/actions/permissions/self-hosted-runners", + "title": "Set self-hosted runners permissions for an enterprise", + "category": "actions", + "subcategory": "permissions", + "parameters": [ + { + "name": "enterprise", + "description": "

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "boolean", + "name": "disable_self_hosted_runners_for_all_orgs", + "in": "body", + "description": "

When true, repository-level runners will be disabled across all organizations in the enterprise

", + "isRequired": true + } + ], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Disable repository-level runners across all organizations", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "disable_self_hosted_runners_for_all_orgs": true + }, + "parameters": { + "enterprise": "ENTERPRISE" + } + }, + "response": { + "statusCode": "204", + "description": "

Response

" + } + } + ], + "previews": [], + "descriptionHTML": "

Sets the settings for whether organizations in the enterprise are allowed to manage self-hosted runners at the repository level.

", + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "

No Content

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + } + ] + }, { "serverUrl": "https://api.github.com", "verb": "get", @@ -7452,8 +8071,174 @@ { "serverUrl": "https://api.github.com", "verb": "get", - "requestPath": "/orgs/{org}/actions/permissions", - "title": "Get GitHub Actions permissions for an organization", + "requestPath": "/organizations/{org}/actions/permissions/artifact-and-log-retention", + "title": "Get artifact and log retention settings for an organization", + "category": "actions", + "subcategory": "permissions", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Administration\" organization permissions": "read" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Example response

", + "example": { + "days": 90, + "maximum_allowed_days": 365 + }, + "schema": { + "type": "object", + "properties": { + "days": { + "type": "integer", + "description": "The number of days artifacts and logs are retained" + }, + "maximum_allowed_days": { + "type": "integer", + "description": "The maximum number of days that can be configured" + } + }, + "required": [ + "days", + "maximum_allowed_days" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "

Gets artifact and log retention settings for an organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope or the \"Actions policies\" fine-grained permission to use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/organizations/{org}/actions/permissions/artifact-and-log-retention", + "title": "Set artifact and log retention settings for an organization", + "category": "actions", + "subcategory": "permissions", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "integer", + "name": "days", + "in": "body", + "description": "

The number of days to retain artifacts and logs

", + "isRequired": true + } + ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Administration\" organization permissions": "write" + } + ] + }, + "codeExamples": [ + { + "key": "application/json", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "days": 100 + }, + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "204", + "description": "

No content

" + } + } + ], + "previews": [], + "descriptionHTML": "

Sets artifact and log retention settings for an organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope or the \"Actions policies\" fine-grained permission to use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "

No content

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "409", + "description": "

Conflict

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/organizations/{org}/actions/permissions/fork-pr-contributor-approval", + "title": "Get fork PR contributor approval permissions for an organization", "category": "actions", "subcategory": "permissions", "parameters": [ @@ -7493,61 +8278,408 @@ "contentType": "application/json", "description": "

Response

", "example": { - "enabled_repositories": "all", - "allowed_actions": "selected", - "selected_actions_url": "https://api.github.com/organizations/42/actions/permissions/selected-actions" + "approval_policy": "first_time_contributors" }, "schema": { "type": "object", "properties": { - "enabled_repositories": { + "approval_policy": { "type": "string", - "description": "The policy that controls the repositories in the organization that are allowed to run GitHub Actions.", "enum": [ - "all", - "none", - "selected" - ] + "first_time_contributors_new_to_github", + "first_time_contributors", + "all_external_contributors" + ], + "description": "The policy that controls when fork PR workflows require approval from a maintainer." + } + }, + "required": [ + "approval_policy" + ] + } + } + } + ], + "previews": [], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ], + "descriptionHTML": "

Gets the fork PR contributor approval policy for an organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope or the \"Actions policies\" fine-grained permission to use this endpoint.

" + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/organizations/{org}/actions/permissions/fork-pr-contributor-approval", + "title": "Set fork PR contributor approval permissions for an organization", + "category": "actions", + "subcategory": "permissions", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "approval_policy", + "in": "body", + "description": "

The policy that controls when fork PR workflows require approval from a maintainer.

", + "isRequired": true, + "enum": [ + "first_time_contributors_new_to_github", + "first_time_contributors", + "all_external_contributors" + ] + } + ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Administration\" organization permissions": "write" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Set approval policy to first time contributors", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "approval_policy": "first_time_contributors" + }, + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "204", + "description": "

Response

" + } + } + ], + "previews": [], + "descriptionHTML": "

Sets the fork PR contributor approval policy for an organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "

No Content

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/organizations/{org}/actions/permissions/fork-pr-workflows-private-repos", + "title": "Get private repo fork PR workflow settings for an organization", + "category": "actions", + "subcategory": "permissions", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Administration\" organization permissions": "read" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "run_workflows_from_fork_pull_requests": true, + "send_write_tokens_to_workflows": false, + "send_secrets_and_variables": false, + "require_approval_for_fork_pr_workflows": true + }, + "schema": { + "type": "object", + "required": [ + "run_workflows_from_fork_pull_requests", + "send_write_tokens_to_workflows", + "send_secrets_and_variables", + "require_approval_for_fork_pr_workflows" + ], + "properties": { + "run_workflows_from_fork_pull_requests": { + "type": "boolean", + "description": "Whether workflows triggered by pull requests from forks are allowed to run on private repositories." }, - "selected_repositories_url": { - "type": "string", - "description": "The API URL to use to get or set the selected repositories that are allowed to run GitHub Actions, when `enabled_repositories` is set to `selected`." + "send_write_tokens_to_workflows": { + "type": "boolean", + "description": "Whether GitHub Actions can create pull requests or submit approving pull request reviews from a workflow triggered by a fork pull request." }, - "allowed_actions": { + "send_secrets_and_variables": { + "type": "boolean", + "description": "Whether to make secrets and variables available to workflows triggered by pull requests from forks." + }, + "require_approval_for_fork_pr_workflows": { + "type": "boolean", + "description": "Whether workflows triggered by pull requests from forks require approval from a repository administrator to run." + } + } + } + } + } + ], + "previews": [], + "descriptionHTML": "

Gets the settings for whether workflows from fork pull requests can run on private repositories in an organization.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/organizations/{org}/actions/permissions/fork-pr-workflows-private-repos", + "title": "Set private repo fork PR workflow settings for an organization", + "category": "actions", + "subcategory": "permissions", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "boolean", + "name": "run_workflows_from_fork_pull_requests", + "in": "body", + "description": "

Whether workflows triggered by pull requests from forks are allowed to run on private repositories.

", + "isRequired": true + }, + { + "type": "boolean", + "name": "send_write_tokens_to_workflows", + "in": "body", + "description": "

Whether GitHub Actions can create pull requests or submit approving pull request reviews from a workflow triggered by a fork pull request.

" + }, + { + "type": "boolean", + "name": "send_secrets_and_variables", + "in": "body", + "description": "

Whether to make secrets and variables available to workflows triggered by pull requests from forks.

" + }, + { + "type": "boolean", + "name": "require_approval_for_fork_pr_workflows", + "in": "body", + "description": "

Whether workflows triggered by pull requests from forks require approval from a repository administrator to run.

" + } + ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Administration\" organization permissions": "write" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "run_workflows_from_fork_pull_requests": true, + "send_write_tokens_to_workflows": false, + "send_secrets_and_variables": false, + "require_approval_for_fork_pr_workflows": true + }, + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "204", + "description": "

Empty response for successful settings update

" + } + } + ], + "previews": [], + "descriptionHTML": "

Sets the settings for whether workflows from fork pull requests can run on private repositories in an organization.

", + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "

Empty response for successful settings update

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden - Fork PR workflow settings for private repositories are managed by the enterprise owner

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/organizations/{org}/actions/permissions/self-hosted-runners", + "title": "Get self-hosted runners settings for an organization", + "category": "actions", + "subcategory": "permissions", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Administration\" organization permissions": "read" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Example response

", + "example": { + "enabled_repositories": "selected", + "selected_repositories_url": "http://api.github.localhost/organizations/1/actions/permissions/self-hosted-runners/repositories" + }, + "schema": { + "type": "object", + "required": [ + "enabled_repositories" + ], + "properties": { + "enabled_repositories": { "type": "string", - "description": "The permissions policy that controls the actions and reusable workflows that are allowed to run.", + "description": "The policy that controls whether self-hosted runners can be used by repositories in the organization", "enum": [ "all", - "local_only", - "selected" + "selected", + "none" ] }, - "selected_actions_url": { + "selected_repositories_url": { "type": "string", - "description": "The API URL to use to get or set the actions and reusable workflows that are allowed to run, when `allowed_actions` is set to `selected`." + "description": "The URL to the endpoint for managing selected repositories for self-hosted runners in the organization" } - }, - "required": [ - "enabled_repositories" - ] + } } } } ], "previews": [], - "descriptionHTML": "

Gets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization.

\n

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", + "descriptionHTML": "

Gets the settings for self-hosted runners for an organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope or the \"Actions policies\" fine-grained permission to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", - "requestPath": "/orgs/{org}/actions/permissions", - "title": "Set GitHub Actions permissions for an organization", + "requestPath": "/organizations/{org}/actions/permissions/self-hosted-runners", + "title": "Set self-hosted runners settings for an organization", "category": "actions", "subcategory": "permissions", "parameters": [ @@ -7566,23 +8698,12 @@ "type": "string", "name": "enabled_repositories", "in": "body", - "description": "

The policy that controls the repositories in the organization that are allowed to run GitHub Actions.

", + "description": "

The policy that controls whether self-hosted runners can be used in the organization

", "isRequired": true, "enum": [ "all", - "none", - "selected" - ] - }, - { - "type": "string", - "name": "allowed_actions", - "in": "body", - "description": "

The permissions policy that controls the actions and reusable workflows that are allowed to run.

", - "enum": [ - "all", - "local_only", - "selected" + "selected", + "none" ] } ], @@ -7598,14 +8719,13 @@ }, "codeExamples": [ { - "key": "default", + "key": "application/json", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "enabled_repositories": "all", - "allowed_actions": "selected" + "enabled_repositories": "all" }, "parameters": { "org": "ORG" @@ -7613,24 +8733,40 @@ }, "response": { "statusCode": "204", - "description": "

Response

" + "description": "

No content

" } } ], "previews": [], - "descriptionHTML": "

Sets the GitHub Actions permissions policy for repositories and allowed actions in an organization.

\n

If the organization belongs to an enterprise that has set restrictive permissions at the enterprise level, such as allowed_actions to selected actions, then you cannot override them for the organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", + "descriptionHTML": "

Sets the settings for self-hosted runners for an organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope or the \"Actions policies\" fine-grained permission to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", - "description": "

No Content

" + "description": "

No content

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "409", + "description": "

Conflict

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", - "requestPath": "/orgs/{org}/actions/permissions/repositories", - "title": "List selected repositories enabled for GitHub Actions in an organization", + "requestPath": "/organizations/{org}/actions/permissions/self-hosted-runners/repositories", + "title": "List repositories allowed to use self-hosted runners in an organization", "category": "actions", "subcategory": "permissions", "parameters": [ @@ -7817,13 +8953,9 @@ }, "schema": { "type": "object", - "required": [ - "total_count", - "repositories" - ], "properties": { "total_count": { - "type": "number" + "type": "integer" }, "repositories": { "type": "array", @@ -8783,19 +9915,27 @@ } ], "previews": [], - "descriptionHTML": "

Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", + "descriptionHTML": "

Lists repositories that are allowed to use self-hosted runners in an organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope or the \"Actions policies\" fine-grained permission to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", - "requestPath": "/orgs/{org}/actions/permissions/repositories", - "title": "Set selected repositories enabled for GitHub Actions in an organization", + "requestPath": "/organizations/{org}/actions/permissions/self-hosted-runners/repositories", + "title": "Set repositories allowed to use self-hosted runners in an organization", "category": "actions", "subcategory": "permissions", "parameters": [ @@ -8814,7 +9954,7 @@ "type": "array of integers", "name": "selected_repository_ids", "in": "body", - "description": "

List of repository IDs to enable for GitHub Actions.

", + "description": "

IDs of repositories that can use repository-level self-hosted runners

", "isRequired": true } ], @@ -8830,15 +9970,16 @@ }, "codeExamples": [ { - "key": "default", + "key": "application/json", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "selected_repository_ids": [ - 32, - 42 + 1, + 2, + 3 ] }, "parameters": { @@ -8847,24 +9988,36 @@ }, "response": { "statusCode": "204", - "description": "

Response

" + "description": "

No content

" } } ], "previews": [], - "descriptionHTML": "

Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", + "descriptionHTML": "

Sets repositories that are allowed to use self-hosted runners in an organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope or the \"Actions policies\" fine-grained permission to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", - "description": "

No Content

" + "description": "

No content

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", - "requestPath": "/orgs/{org}/actions/permissions/repositories/{repository_id}", - "title": "Enable a selected repository for GitHub Actions in an organization", + "requestPath": "/organizations/{org}/actions/permissions/self-hosted-runners/repositories/{repository_id}", + "title": "Add a repository to the list of repositories allowed to use self-hosted runners in an organization", "category": "actions", "subcategory": "permissions", "parameters": [ @@ -8912,24 +10065,40 @@ }, "response": { "statusCode": "204", - "description": "

Response

" + "description": "

No content

" } } ], "previews": [], - "descriptionHTML": "

Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories must be must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"

\n

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", + "descriptionHTML": "

Adds a repository to the list of repositories that are allowed to use self-hosted runners in an organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope or the \"Actions policies\" fine-grained permission to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", - "description": "

No Content

" + "description": "

No content

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "409", + "description": "

Conflict

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", - "requestPath": "/orgs/{org}/actions/permissions/repositories/{repository_id}", - "title": "Disable a selected repository for GitHub Actions in an organization", + "requestPath": "/organizations/{org}/actions/permissions/self-hosted-runners/repositories/{repository_id}", + "title": "Remove a repository from the list of repositories allowed to use self-hosted runners in an organization", "category": "actions", "subcategory": "permissions", "parameters": [ @@ -8977,189 +10146,40 @@ }, "response": { "statusCode": "204", - "description": "

Response

" + "description": "

No content

" } } ], "previews": [], - "descriptionHTML": "

Removes a repository from the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"

\n

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", + "descriptionHTML": "

Removes a repository from the list of repositories that are allowed to use self-hosted runners in an organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope or the \"Actions policies\" fine-grained permission to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", - "description": "

No Content

" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/orgs/{org}/actions/permissions/selected-actions", - "title": "Get allowed actions and reusable workflows for an organization", - "category": "actions", - "subcategory": "permissions", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" organization permissions": "read" - } - ] - }, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "github_owned_allowed": true, - "verified_allowed": false, - "patterns_allowed": [ - "monalisa/octocat@*", - "docker/*" - ] - }, - "schema": { - "type": "object", - "properties": { - "github_owned_allowed": { - "type": "boolean", - "description": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization." - }, - "verified_allowed": { - "type": "boolean", - "description": "Whether actions from GitHub Marketplace verified creators are allowed. Set to `true` to allow all actions by GitHub Marketplace verified creators." - }, - "patterns_allowed": { - "type": "array", - "description": "Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.", - "items": { - "type": "string" - } - } - } - } - } - } - ], - "previews": [], - "descriptionHTML": "

Gets the selected actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"

\n

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "put", - "requestPath": "/orgs/{org}/actions/permissions/selected-actions", - "title": "Set allowed actions for an organization", - "category": "actions", - "subcategory": "permissions", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "boolean", - "name": "github_owned_allowed", - "in": "body", - "description": "

Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.

" + "description": "

No content

" }, { - "type": "boolean", - "name": "verified_allowed", - "in": "body", - "description": "

Whether actions from GitHub Marketplace verified creators are allowed. Set to true to allow all actions by GitHub Marketplace verified creators.

" + "httpStatusCode": "403", + "description": "

Forbidden

" }, { - "type": "array of strings", - "name": "patterns_allowed", - "in": "body", - "description": "

Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.

" - } - ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" organization permissions": "write" - } - ] - }, - "codeExamples": [ + "httpStatusCode": "404", + "description": "

Resource not found

" + }, { - "key": "selected_actions", - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "github_owned_allowed": true, - "verified_allowed": false, - "patterns_allowed": [ - "monalisa/octocat@*", - "docker/*" - ] - }, - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "previews": [], - "descriptionHTML": "

Sets the actions that are allowed in an organization. To use this endpoint, the organization permission policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"

\n

If the organization belongs to an enterprise that has selected actions set at the enterprise level, then you cannot override any of the enterprise's allowed actions settings.

\n

To use the patterns_allowed setting for private repositories, the organization must belong to an enterprise. If the organization does not belong to an enterprise, then the patterns_allowed setting only applies to public repositories in the organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", - "statusCodes": [ + "httpStatusCode": "409", + "description": "

Conflict

" + }, { - "httpStatusCode": "204", - "description": "

No Content

" + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", - "requestPath": "/orgs/{org}/actions/permissions/workflow", - "title": "Get default workflow permissions for an organization", + "requestPath": "/orgs/{org}/actions/permissions", + "title": "Get GitHub Actions permissions for an organization", "category": "actions", "subcategory": "permissions", "parameters": [ @@ -9197,188 +10217,27 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "

Give read-only permission, and allow approving PRs.

", + "description": "

Response

", "example": { - "default_workflow_permissions": "read", - "can_approve_pull_request_reviews": true + "enabled_repositories": "all", + "allowed_actions": "selected", + "selected_actions_url": "https://api.github.com/organizations/42/actions/permissions/selected-actions" }, "schema": { "type": "object", "properties": { - "default_workflow_permissions": { + "enabled_repositories": { "type": "string", - "description": "The default workflow permissions granted to the GITHUB_TOKEN when running workflows.", + "description": "The policy that controls the repositories in the organization that are allowed to run GitHub Actions.", "enum": [ - "read", - "write" + "all", + "none", + "selected" ] }, - "can_approve_pull_request_reviews": { - "type": "boolean", - "description": "Whether GitHub Actions can approve pull requests. Enabling this can be a security risk." - } - }, - "required": [ - "default_workflow_permissions", - "can_approve_pull_request_reviews" - ] - } - } - } - ], - "previews": [], - "descriptionHTML": "

Gets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in an organization,\nas well as whether GitHub Actions can submit approving pull request reviews. For more information, see\n\"Setting the permissions of the GITHUB_TOKEN for your organization.\"

\n

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "put", - "requestPath": "/orgs/{org}/actions/permissions/workflow", - "title": "Set default workflow permissions for an organization", - "category": "actions", - "subcategory": "permissions", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "default_workflow_permissions", - "in": "body", - "description": "

The default workflow permissions granted to the GITHUB_TOKEN when running workflows.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "boolean", - "name": "can_approve_pull_request_reviews", - "in": "body", - "description": "

Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.

" - } - ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" organization permissions": "write" - } - ] - }, - "codeExamples": [ - { - "key": "default", - "request": { - "contentType": "application/json", - "description": "Give read-only permission, and allow approving PRs.", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "default_workflow_permissions": "read", - "can_approve_pull_request_reviews": true - }, - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "204", - "description": "

Success response

" - } - } - ], - "previews": [], - "descriptionHTML": "

Sets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in an organization, and sets if GitHub Actions\ncan submit approving pull request reviews. For more information, see\n\"Setting the permissions of the GITHUB_TOKEN for your organization.\"

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

Success response

" - }, - { - "httpStatusCode": "409", - "description": "

Conflict response when changing a setting is prevented by the owning enterprise

" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/permissions", - "title": "Get GitHub Actions permissions for a repository", - "category": "actions", - "subcategory": "permissions", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "read" - } - ] - }, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "enabled": true, - "allowed_actions": "selected", - "selected_actions_url": "https://api.github.com/repositories/42/actions/permissions/selected-actions" - }, - "schema": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean", - "description": "Whether GitHub Actions is enabled on the repository." + "selected_repositories_url": { + "type": "string", + "description": "The API URL to use to get or set the selected repositories that are allowed to run GitHub Actions, when `enabled_repositories` is set to `selected`." }, "allowed_actions": { "type": "string", @@ -9395,14 +10254,14 @@ } }, "required": [ - "enabled" + "enabled_repositories" ] } } } ], "previews": [], - "descriptionHTML": "

Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions and reusable workflows allowed to run in the repository.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", + "descriptionHTML": "

Gets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization.

\n

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -9413,23 +10272,14 @@ { "serverUrl": "https://api.github.com", "verb": "put", - "requestPath": "/repos/{owner}/{repo}/actions/permissions", - "title": "Set GitHub Actions permissions for a repository", + "requestPath": "/orgs/{org}/actions/permissions", + "title": "Set GitHub Actions permissions for an organization", "category": "actions", "subcategory": "permissions", "parameters": [ { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", "in": "path", "required": true, "schema": { @@ -9439,11 +10289,16 @@ ], "bodyParameters": [ { - "type": "boolean", - "name": "enabled", + "type": "string", + "name": "enabled_repositories", "in": "body", - "description": "

Whether GitHub Actions is enabled on the repository.

", - "isRequired": true + "description": "

The policy that controls the repositories in the organization that are allowed to run GitHub Actions.

", + "isRequired": true, + "enum": [ + "all", + "none", + "selected" + ] }, { "type": "string", @@ -9463,7 +10318,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Administration\" repository permissions": "write" + "\"Administration\" organization permissions": "write" } ] }, @@ -9475,12 +10330,11 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "enabled": true, + "enabled_repositories": "all", "allowed_actions": "selected" }, "parameters": { - "owner": "OWNER", - "repo": "REPO" + "org": "ORG" } }, "response": { @@ -9490,7 +10344,7 @@ } ], "previews": [], - "descriptionHTML": "

Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions in the repository.

\n

If the repository belongs to an organization or enterprise that has set restrictive permissions at the organization or enterprise levels, such as allowed_actions to selected actions, then you cannot override them for the repository.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", + "descriptionHTML": "

Sets the GitHub Actions permissions policy for repositories and allowed actions in an organization.

\n

If the organization belongs to an enterprise that has set restrictive permissions at the enterprise level, such as allowed_actions to selected actions, then you cannot override them for the organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", @@ -9501,100 +10355,14 @@ { "serverUrl": "https://api.github.com", "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/permissions/access", - "title": "Get the level of access for workflows outside of the repository", - "category": "actions", - "subcategory": "permissions", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "read" - } - ] - }, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "access_level": "organization" - }, - "schema": { - "type": "object", - "properties": { - "access_level": { - "type": "string", - "description": "Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the\nrepository.\n\n`none` means the access is only possible from workflows in this repository. `user` level access allows sharing across user owned private repositories only. `organization` level access allows sharing across the organization. `enterprise` level access allows sharing across the enterprise.", - "enum": [ - "none", - "user", - "organization", - "enterprise" - ] - } - }, - "required": [ - "access_level" - ] - } - } - } - ], - "previews": [], - "descriptionHTML": "

Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal and private repositories.\nFor more information, see \"Allowing access to components in a private repository\" and\n\"Allowing access to components in an internal repository.\"

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/actions/permissions/access", - "title": "Set the level of access for workflows outside of the repository", + "requestPath": "/orgs/{org}/actions/permissions/repositories", + "title": "List selected repositories enabled for GitHub Actions in an organization", "category": "actions", "subcategory": "permissions", "parameters": [ { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", "in": "path", "required": true, "schema": { @@ -9602,94 +10370,21 @@ } }, { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "access_level", - "in": "body", - "description": "

Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the\nrepository.

\n

none means the access is only possible from workflows in this repository. user level access allows sharing across user owned private repositories only. organization level access allows sharing across the organization. enterprise level access allows sharing across the enterprise.

", - "isRequired": true, - "enum": [ - "none", - "user", - "organization", - "enterprise" - ] - } - ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "write" - } - ] - }, - "codeExamples": [ - { - "key": "default", - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "access_level": "organization" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "previews": [], - "descriptionHTML": "

Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal and private repositories.\nFor more information, see \"Allowing access to components in a private repository\" and\n\"Allowing access to components in an internal repository.\"

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/permissions/selected-actions", - "title": "Get allowed actions and reusable workflows for a repository", - "category": "actions", - "subcategory": "permissions", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, + "name": "per_page", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "in": "query", "schema": { - "type": "string" + "type": "integer", + "default": 30 } }, { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, + "name": "page", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "in": "query", "schema": { - "type": "string" + "type": "integer", + "default": 1 } } ], @@ -9700,7 +10395,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Administration\" repository permissions": "read" + "\"Administration\" organization permissions": "read" } ] }, @@ -9711,8 +10406,7 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "owner": "OWNER", - "repo": "REPO" + "org": "ORG" } }, "response": { @@ -9720,1075 +10414,156 @@ "contentType": "application/json", "description": "

Response

", "example": { - "github_owned_allowed": true, - "verified_allowed": false, - "patterns_allowed": [ - "monalisa/octocat@*", - "docker/*" + "total_count": 1, + "repositories": [ + { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "allow_rebase_merge": true, + "template_repository": null, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "allow_auto_merge": false, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + } ] }, "schema": { "type": "object", + "required": [ + "total_count", + "repositories" + ], "properties": { - "github_owned_allowed": { - "type": "boolean", - "description": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization." - }, - "verified_allowed": { - "type": "boolean", - "description": "Whether actions from GitHub Marketplace verified creators are allowed. Set to `true` to allow all actions by GitHub Marketplace verified creators." + "total_count": { + "type": "number" }, - "patterns_allowed": { + "repositories": { "type": "array", - "description": "Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.", "items": { - "type": "string" - } - } - } - } - } - } - ], - "previews": [], - "descriptionHTML": "

Gets the settings for selected actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for a repository.\"

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/actions/permissions/selected-actions", - "title": "Set allowed actions for a repository", - "category": "actions", - "subcategory": "permissions", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "boolean", - "name": "github_owned_allowed", - "in": "body", - "description": "

Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.

" - }, - { - "type": "boolean", - "name": "verified_allowed", - "in": "body", - "description": "

Whether actions from GitHub Marketplace verified creators are allowed. Set to true to allow all actions by GitHub Marketplace verified creators.

" - }, - { - "type": "array of strings", - "name": "patterns_allowed", - "in": "body", - "description": "

Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.

" - } - ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "write" - } - ] - }, - "codeExamples": [ - { - "key": "selected_actions", - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "github_owned_allowed": true, - "verified_allowed": false, - "patterns_allowed": [ - "monalisa/octocat@*", - "docker/*" - ] - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "previews": [], - "descriptionHTML": "

Sets the actions that are allowed in a repository. To use this endpoint, the repository permission policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for a repository.\"

\n

If the repository belongs to an organization or enterprise that has selected actions set at the organization or enterprise levels, then you cannot override any of the allowed actions settings and reusable workflows settings.

\n

To use the patterns_allowed setting for private repositories, the repository must belong to an enterprise. If the repository does not belong to an enterprise, then the patterns_allowed setting only applies to public repositories.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/permissions/workflow", - "title": "Get default workflow permissions for a repository", - "category": "actions", - "subcategory": "permissions", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "read" - } - ] - }, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Give read-only permission, and allow approving PRs.

", - "example": { - "default_workflow_permissions": "read", - "can_approve_pull_request_reviews": true - }, - "schema": { - "type": "object", - "properties": { - "default_workflow_permissions": { - "type": "string", - "description": "The default workflow permissions granted to the GITHUB_TOKEN when running workflows.", - "enum": [ - "read", - "write" - ] - }, - "can_approve_pull_request_reviews": { - "type": "boolean", - "description": "Whether GitHub Actions can approve pull requests. Enabling this can be a security risk." - } - }, - "required": [ - "default_workflow_permissions", - "can_approve_pull_request_reviews" - ] - } - } - } - ], - "previews": [], - "descriptionHTML": "

Gets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in a repository,\nas well as if GitHub Actions can submit approving pull request reviews.\nFor more information, see \"Setting the permissions of the GITHUB_TOKEN for your repository.\"

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/actions/permissions/workflow", - "title": "Set default workflow permissions for a repository", - "category": "actions", - "subcategory": "permissions", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "default_workflow_permissions", - "in": "body", - "description": "

The default workflow permissions granted to the GITHUB_TOKEN when running workflows.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "boolean", - "name": "can_approve_pull_request_reviews", - "in": "body", - "description": "

Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.

" - } - ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "write" - } - ] - }, - "codeExamples": [ - { - "key": "default", - "request": { - "contentType": "application/json", - "description": "Give read-only permission, and allow approving PRs.", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "default_workflow_permissions": "read", - "can_approve_pull_request_reviews": true - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "204", - "description": "

Success response

" - } - } - ], - "previews": [], - "descriptionHTML": "

Sets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in a repository, and sets if GitHub Actions\ncan submit approving pull request reviews.\nFor more information, see \"Setting the permissions of the GITHUB_TOKEN for your repository.\"

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

Success response

" - }, - { - "httpStatusCode": "409", - "description": "

Conflict response when changing a setting is prevented by the owning organization or enterprise

" - } - ] - } - ], - "secrets": [ - { - "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/orgs/{org}/actions/secrets", - "title": "List organization secrets", - "category": "actions", - "subcategory": "secrets", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Secrets\" organization permissions": "read" - } - ] - }, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "total_count": 3, - "secrets": [ - { - "name": "GIST_ID", - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z", - "visibility": "private" - }, - { - "name": "DEPLOY_TOKEN", - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z", - "visibility": "all" - }, - { - "name": "GH_TOKEN", - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z", - "visibility": "selected", - "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/secrets/SUPER_SECRET/repositories" - } - ] - }, - "schema": { - "type": "object", - "required": [ - "total_count", - "secrets" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "secrets": { - "type": "array", - "items": { - "title": "Actions Secret for an Organization", - "description": "Secrets for GitHub Actions for an organization.", - "type": "object", - "properties": { - "name": { - "description": "The name of the secret.", - "type": "string", - "examples": [ - "SECRET_TOKEN" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "visibility": { - "description": "Visibility of a secret", - "enum": [ - "all", - "private", - "selected" - ], - "type": "string" - }, - "selected_repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/org/secrets/my_secret/repositories" - ] - } - }, - "required": [ - "name", - "created_at", - "updated_at", - "visibility" - ] - } - } - } - } - } - } - ], - "previews": [], - "descriptionHTML": "

Lists all secrets available in an organization without revealing their\nencrypted values.

\n

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

", - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/orgs/{org}/actions/secrets/public-key", - "title": "Get an organization public key", - "category": "actions", - "subcategory": "secrets", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Secrets\" organization permissions": "read" - } - ] - }, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "key_id": "012345678912345678", - "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" - }, - "schema": { - "title": "ActionsPublicKey", - "description": "The public key used for setting Actions Secrets.", - "type": "object", - "properties": { - "key_id": { - "description": "The identifier for the key.", - "type": "string", - "examples": [ - "1234567" - ] - }, - "key": { - "description": "The Base64 encoded public key.", - "type": "string", - "examples": [ - "hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=" - ] - }, - "id": { - "type": "integer", - "examples": [ - 2 - ] - }, - "url": { - "type": "string", - "examples": [ - "https://api.github.com/user/keys/2" - ] - }, - "title": { - "type": "string", - "examples": [ - "ssh-rsa AAAAB3NzaC1yc2EAAA" - ] - }, - "created_at": { - "type": "string", - "examples": [ - "2011-01-26T19:01:12Z" - ] - } - }, - "required": [ - "key_id", - "key" - ] - } - } - } - ], - "previews": [], - "descriptionHTML": "

Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.

\n

The authenticated user must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/orgs/{org}/actions/secrets/{secret_name}", - "title": "Get an organization secret", - "category": "actions", - "subcategory": "secrets", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "secret_name", - "description": "

The name of the secret.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Secrets\" organization permissions": "read" - } - ] - }, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "secret_name": "SECRET_NAME" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "name": "GH_TOKEN", - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z", - "visibility": "selected", - "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/secrets/SUPER_SECRET/repositories" - }, - "schema": { - "title": "Actions Secret for an Organization", - "description": "Secrets for GitHub Actions for an organization.", - "type": "object", - "properties": { - "name": { - "description": "The name of the secret.", - "type": "string", - "examples": [ - "SECRET_TOKEN" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "visibility": { - "description": "Visibility of a secret", - "enum": [ - "all", - "private", - "selected" - ], - "type": "string" - }, - "selected_repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/org/secrets/my_secret/repositories" - ] - } - }, - "required": [ - "name", - "created_at", - "updated_at", - "visibility" - ] - } - } - } - ], - "previews": [], - "descriptionHTML": "

Gets a single organization secret without revealing its encrypted value.

\n

The authenticated user must have collaborator access to a repository to create, update, or read secrets

\n

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "put", - "requestPath": "/orgs/{org}/actions/secrets/{secret_name}", - "title": "Create or update an organization secret", - "category": "actions", - "subcategory": "secrets", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "secret_name", - "description": "

The name of the secret.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "encrypted_value", - "in": "body", - "description": "

Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an organization public key endpoint.

", - "isRequired": true - }, - { - "type": "string", - "name": "key_id", - "in": "body", - "description": "

ID of the key you used to encrypt the secret.

", - "isRequired": true - }, - { - "type": "string", - "name": "visibility", - "in": "body", - "description": "

Which type of organization repositories have access to the organization secret. selected means only the repositories specified by selected_repository_ids can access the secret.

", - "isRequired": true, - "enum": [ - "all", - "private", - "selected" - ] - }, - { - "type": "array of integers", - "name": "selected_repository_ids", - "in": "body", - "description": "

An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can manage the list of selected repositories using the List selected repositories for an organization secret, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints.

" - } - ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Secrets\" organization permissions": "write" - } - ] - }, - "codeExamples": [ - { - "key": "default", - "request": { - "contentType": "application/json", - "description": "Example 1: Status Code 201", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "encrypted_value": "c2VjcmV0", - "key_id": "012345678912345678", - "visibility": "selected", - "selected_repository_ids": [ - 1296269, - 1296280 - ] - }, - "parameters": { - "org": "ORG", - "secret_name": "SECRET_NAME" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response when creating a secret

", - "example": null, - "schema": { - "title": "Empty Object", - "description": "An object without any properties.", - "type": "object", - "properties": {}, - "additionalProperties": false - } - } - }, - { - "key": "204", - "request": { - "contentType": "application/json", - "description": "Example 2: Status Code 204", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "encrypted_value": "c2VjcmV0", - "key_id": "012345678912345678", - "visibility": "selected", - "selected_repository_ids": [ - 1296269, - 1296280 - ] - }, - "parameters": { - "org": "ORG", - "secret_name": "SECRET_NAME" - } - }, - "response": { - "statusCode": "204", - "description": "

Response when updating a secret

" - } - } - ], - "previews": [], - "descriptionHTML": "

Creates or updates an organization secret with an encrypted value. Encrypt your secret using\nLibSodium. For more information, see \"Encrypting secrets for the REST API.\"

\n

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Response when creating a secret

" - }, - { - "httpStatusCode": "204", - "description": "

Response when updating a secret

" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/secrets/{secret_name}", - "title": "Delete an organization secret", - "category": "actions", - "subcategory": "secrets", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "secret_name", - "description": "

The name of the secret.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Secrets\" organization permissions": "write" - } - ] - }, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "secret_name": "SECRET_NAME" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "previews": [], - "descriptionHTML": "

Deletes a secret in an organization using the secret name.

\n

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/orgs/{org}/actions/secrets/{secret_name}/repositories", - "title": "List selected repositories for an organization secret", - "category": "actions", - "subcategory": "secrets", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "secret_name", - "description": "

The name of the secret.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - } - ], - "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Secrets\" organization permissions": "read" - } - ] - }, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "secret_name": "SECRET_NAME" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "total_count": 1, - "repositories": [ - { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "owner": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World", - "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" - } - ] - }, - "schema": { - "type": "object", - "required": [ - "total_count", - "repositories" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "repositories": { - "type": "array", - "items": { - "title": "Minimal Repository", - "description": "Minimal Repository", + "title": "Repository", + "description": "A repository on GitHub.", "type": "object", "properties": { "id": { + "description": "Unique identifier of the repository", "type": "integer", "format": "int64", "examples": [ - 1296269 + 42 ] }, "node_id": { @@ -10798,9 +10573,10 @@ ] }, "name": { + "description": "The name of the repository.", "type": "string", "examples": [ - "Hello-World" + "Team Environment" ] }, "full_name": { @@ -10809,6 +10585,96 @@ "octocat/Hello-World" ] }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, "owner": { "title": "Simple User", "description": "A GitHub user.", @@ -10978,6 +10844,8 @@ ] }, "private": { + "description": "Whether the repository is private or public.", + "default": false, "type": "boolean" }, "html_url": { @@ -11114,7 +10982,10 @@ ] }, "git_url": { - "type": "string" + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] }, "issue_comment_url": { "type": "string", @@ -11185,7 +11056,10 @@ ] }, "ssh_url": { - "type": "string" + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] }, "stargazers_url": { "type": "string", @@ -11235,12 +11109,19 @@ ] }, "clone_url": { - "type": "string" + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] }, "mirror_url": { "type": [ "string", "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { @@ -11251,12 +11132,20 @@ ] }, "svn_url": { - "type": "string" + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] }, "homepage": { "type": [ "string", "null" + ], + "format": "uri", + "examples": [ + "https://github.com" ] }, "language": { @@ -11266,26 +11155,50 @@ ] }, "forks_count": { - "type": "integer" + "type": "integer", + "examples": [ + 9 + ] }, "stargazers_count": { - "type": "integer" + "type": "integer", + "examples": [ + 80 + ] }, "watchers_count": { - "type": "integer" + "type": "integer", + "examples": [ + 80 + ] }, "size": { "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" + "type": "integer", + "examples": [ + 108 + ] }, "default_branch": { - "type": "string" + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] }, "open_issues_count": { - "type": "integer" + "type": "integer", + "examples": [ + 0 + ] }, "is_template": { - "type": "boolean" + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] }, "topics": { "type": "array", @@ -11294,30 +11207,61 @@ } }, "has_issues": { - "type": "boolean" + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] }, "has_projects": { - "type": "boolean" + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] }, "has_wiki": { - "type": "boolean" + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] }, "has_pages": { "type": "boolean" }, "has_downloads": { - "type": "boolean" + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, + "examples": [ + true + ] }, "has_discussions": { - "type": "boolean" + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] }, "archived": { + "description": "Whether the repository is archived.", + "default": false, "type": "boolean" }, "disabled": { - "type": "boolean" + "type": "boolean", + "description": "Returns whether or not this repository disabled." }, "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", "type": "string" }, "pushed_at": { @@ -11350,250 +11294,136 @@ "2011-01-26T19:14:43Z" ] }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", "examples": [ - "admin" + true ] }, "temp_clone_token": { "type": "string" }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "contributor_covenant" - ] - }, - "name": { - "type": "string", - "examples": [ - "Contributor Covenant" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/codes_of_conduct/contributor_covenant" - ] - }, - "body": { - "type": "string", - "examples": [ - "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" - ] - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true ] }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - } + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] }, - "forks": { - "type": "integer", + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", "examples": [ - 0 + false ] }, - "open_issues": { - "type": "integer", + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", "examples": [ - 0 + false ] }, - "watchers": { - "type": "integer", + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", "examples": [ - 0 + true ] }, "allow_forking": { + "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { - "type": "boolean", + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", "examples": [ - false + "\"2020-07-09T00:17:42Z\"" ] }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "code_security": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_non_provider_patterns": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_ai_detection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } + "lexical_search_ok": { + "type": "boolean" }, - "secret_scanning_validity_checks": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } + "lexical_commit_sha": { + "type": "string" } } - }, - "custom_properties": { - "type": "object", - "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", - "additionalProperties": true } }, "required": [ @@ -11642,7 +11472,34 @@ "tags_url", "teams_url", "trees_url", - "url" + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" ] } } @@ -11652,7 +11509,7 @@ } ], "previews": [], - "descriptionHTML": "

Lists all repositories that have been selected when the visibility\nfor repository access to a secret is set to selected.

\n

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

", + "descriptionHTML": "

Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -11663,10 +11520,10 @@ { "serverUrl": "https://api.github.com", "verb": "put", - "requestPath": "/orgs/{org}/actions/secrets/{secret_name}/repositories", - "title": "Set selected repositories for an organization secret", + "requestPath": "/orgs/{org}/actions/permissions/repositories", + "title": "Set selected repositories enabled for GitHub Actions in an organization", "category": "actions", - "subcategory": "secrets", + "subcategory": "permissions", "parameters": [ { "name": "org", @@ -11676,15 +11533,6 @@ "schema": { "type": "string" } - }, - { - "name": "secret_name", - "description": "

The name of the secret.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } } ], "bodyParameters": [ @@ -11692,7 +11540,7 @@ "type": "array of integers", "name": "selected_repository_ids", "in": "body", - "description": "

An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can add and remove individual repositories using the Add selected repository to an organization secret and Remove selected repository from an organization secret endpoints.

", + "description": "

List of repository IDs to enable for GitHub Actions.

", "isRequired": true } ], @@ -11702,7 +11550,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Secrets\" organization permissions": "write" + "\"Administration\" organization permissions": "write" } ] }, @@ -11715,12 +11563,12 @@ "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "selected_repository_ids": [ - 64780797 + 32, + 42 ] }, "parameters": { - "org": "ORG", - "secret_name": "SECRET_NAME" + "org": "ORG" } }, "response": { @@ -11730,7 +11578,7 @@ } ], "previews": [], - "descriptionHTML": "

Replaces all repositories for an organization secret when the visibility\nfor repository access is set to selected. The visibility is set when you Create\nor update an organization secret.

\n

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

", + "descriptionHTML": "

Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", @@ -11741,10 +11589,10 @@ { "serverUrl": "https://api.github.com", "verb": "put", - "requestPath": "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}", - "title": "Add selected repository to an organization secret", + "requestPath": "/orgs/{org}/actions/permissions/repositories/{repository_id}", + "title": "Enable a selected repository for GitHub Actions in an organization", "category": "actions", - "subcategory": "secrets", + "subcategory": "permissions", "parameters": [ { "name": "org", @@ -11755,23 +11603,14 @@ "type": "string" } }, - { - "name": "secret_name", - "description": "

The name of the secret.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, { "name": "repository_id", + "description": "

The unique identifier of the repository.

", "in": "path", "required": true, "schema": { "type": "integer" - }, - "description": "" + } } ], "bodyParameters": [], @@ -11781,7 +11620,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Secrets\" organization permissions": "write", + "\"Administration\" organization permissions": "write", "\"Metadata\" repository permissions": "read" } ] @@ -11794,36 +11633,31 @@ "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", - "secret_name": "SECRET_NAME", "repository_id": "REPOSITORY_ID" } }, "response": { "statusCode": "204", - "description": "

No Content when repository was added to the selected list

" + "description": "

Response

" } } ], "previews": [], - "descriptionHTML": "

Adds a repository to an organization secret when the visibility for\nrepository access is set to selected. For more information about setting the visibility, see Create or\nupdate an organization secret.

\n

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", + "descriptionHTML": "

Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories must be must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"

\n

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", - "description": "

No Content when repository was added to the selected list

" - }, - { - "httpStatusCode": "409", - "description": "

Conflict when visibility type is not set to selected

" + "description": "

No Content

" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", - "requestPath": "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}", - "title": "Remove selected repository from an organization secret", + "requestPath": "/orgs/{org}/actions/permissions/repositories/{repository_id}", + "title": "Disable a selected repository for GitHub Actions in an organization", "category": "actions", - "subcategory": "secrets", + "subcategory": "permissions", "parameters": [ { "name": "org", @@ -11834,23 +11668,14 @@ "type": "string" } }, - { - "name": "secret_name", - "description": "

The name of the secret.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, { "name": "repository_id", + "description": "

The unique identifier of the repository.

", "in": "path", "required": true, "schema": { "type": "integer" - }, - "description": "" + } } ], "bodyParameters": [], @@ -11860,7 +11685,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Secrets\" organization permissions": "write", + "\"Administration\" organization permissions": "write", "\"Metadata\" repository permissions": "read" } ] @@ -11873,72 +11698,40 @@ "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", - "secret_name": "SECRET_NAME", "repository_id": "REPOSITORY_ID" } }, "response": { "statusCode": "204", - "description": "

Response when repository was removed from the selected list

" + "description": "

Response

" } } ], "previews": [], - "descriptionHTML": "

Removes a repository from an organization secret when the visibility\nfor repository access is set to selected. The visibility is set when you Create\nor update an organization secret.

\n

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

", "statusCodes": [ { "httpStatusCode": "204", - "description": "

Response when repository was removed from the selected list

" - }, - { - "httpStatusCode": "409", - "description": "

Conflict when visibility type not set to selected

" + "description": "

No Content

" } - ] + ], + "descriptionHTML": "

Removes a repository from the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"

\n

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" }, { "serverUrl": "https://api.github.com", "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/organization-secrets", - "title": "List repository organization secrets", + "requestPath": "/orgs/{org}/actions/permissions/selected-actions", + "title": "Get allowed actions and reusable workflows for an organization", "category": "actions", - "subcategory": "secrets", + "subcategory": "permissions", "parameters": [ { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", "in": "path", "required": true, "schema": { "type": "string" } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } } ], "bodyParameters": [], @@ -11948,7 +11741,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Secrets\" repository permissions": "read" + "\"Administration\" organization permissions": "read" } ] }, @@ -11959,8 +11752,7 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "owner": "OWNER", - "repo": "REPO" + "org": "ORG" } }, "response": { @@ -11968,58 +11760,29 @@ "contentType": "application/json", "description": "

Response

", "example": { - "total_count": 2, - "secrets": [ - { - "name": "GH_TOKEN", - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z" - }, - { - "name": "GIST_ID", - "created_at": "2020-01-10T10:59:22Z", - "updated_at": "2020-01-11T11:59:22Z" - } + "github_owned_allowed": true, + "verified_allowed": false, + "patterns_allowed": [ + "monalisa/octocat@*", + "docker/*" ] }, "schema": { "type": "object", - "required": [ - "total_count", - "secrets" - ], "properties": { - "total_count": { - "type": "integer" + "github_owned_allowed": { + "type": "boolean", + "description": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization." }, - "secrets": { + "verified_allowed": { + "type": "boolean", + "description": "Whether actions from GitHub Marketplace verified creators are allowed. Set to `true` to allow all actions by GitHub Marketplace verified creators." + }, + "patterns_allowed": { "type": "array", + "description": "Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.", "items": { - "title": "Actions Secret", - "description": "Set secrets for GitHub Actions.", - "type": "object", - "properties": { - "name": { - "description": "The name of the secret.", - "type": "string", - "examples": [ - "SECRET_TOKEN" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "name", - "created_at", - "updated_at" - ] + "type": "string" } } } @@ -12028,174 +11791,107 @@ } ], "previews": [], - "descriptionHTML": "

Lists all organization secrets shared with a repository without revealing their encrypted\nvalues.

\n

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Gets the selected actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"

\n

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" }, { "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/secrets", - "title": "List repository secrets", + "verb": "put", + "requestPath": "/orgs/{org}/actions/permissions/selected-actions", + "title": "Set allowed actions for an organization", "category": "actions", - "subcategory": "secrets", + "subcategory": "permissions", "parameters": [ { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", "in": "path", "required": true, "schema": { "type": "string" } - }, + } + ], + "bodyParameters": [ { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } + "type": "boolean", + "name": "github_owned_allowed", + "in": "body", + "description": "

Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.

" }, { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } + "type": "boolean", + "name": "verified_allowed", + "in": "body", + "description": "

Whether actions from GitHub Marketplace verified creators are allowed. Set to true to allow all actions by GitHub Marketplace verified creators.

" }, { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } + "type": "array of strings", + "name": "patterns_allowed", + "in": "body", + "description": "

Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.

" } ], - "bodyParameters": [], "progAccess": { "userToServerRest": true, "serverToServer": true, "fineGrainedPat": true, "permissions": [ { - "\"Secrets\" repository permissions": "read" + "\"Administration\" organization permissions": "write" } ] }, "codeExamples": [ { - "key": "default", + "key": "selected_actions", "request": { + "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "github_owned_allowed": true, + "verified_allowed": false, + "patterns_allowed": [ + "monalisa/octocat@*", + "docker/*" + ] + }, "parameters": { - "owner": "OWNER", - "repo": "REPO" + "org": "ORG" } }, "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "total_count": 2, - "secrets": [ - { - "name": "GH_TOKEN", - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z" - }, - { - "name": "GIST_ID", - "created_at": "2020-01-10T10:59:22Z", - "updated_at": "2020-01-11T11:59:22Z" - } - ] - }, - "schema": { - "type": "object", - "required": [ - "total_count", - "secrets" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "secrets": { - "type": "array", - "items": { - "title": "Actions Secret", - "description": "Set secrets for GitHub Actions.", - "type": "object", - "properties": { - "name": { - "description": "The name of the secret.", - "type": "string", - "examples": [ - "SECRET_TOKEN" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "name", - "created_at", - "updated_at" - ] - } - } - } - } + "statusCode": "204", + "description": "

Response

" } } ], "previews": [], - "descriptionHTML": "

Lists all secrets available in a repository without revealing their encrypted\nvalues.

\n

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", + "descriptionHTML": "

Sets the actions that are allowed in an organization. To use this endpoint, the organization permission policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"

\n

If the organization belongs to an enterprise that has selected actions set at the enterprise level, then you cannot override any of the enterprise's allowed actions settings.

\n

To use the patterns_allowed setting for private repositories, the organization must belong to an enterprise. If the organization does not belong to an enterprise, then the patterns_allowed setting only applies to public repositories in the organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { - "httpStatusCode": "200", - "description": "

OK

" + "httpStatusCode": "204", + "description": "

No Content

" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/secrets/public-key", - "title": "Get a repository public key", + "requestPath": "/orgs/{org}/actions/permissions/workflow", + "title": "Get default workflow permissions for an organization", "category": "actions", - "subcategory": "secrets", + "subcategory": "permissions", "parameters": [ { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", "in": "path", "required": true, "schema": { @@ -12210,7 +11906,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Secrets\" repository permissions": "read" + "\"Administration\" organization permissions": "read" } ] }, @@ -12221,72 +11917,43 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "owner": "OWNER", - "repo": "REPO" + "org": "ORG" } }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "

Response

", + "description": "

Give read-only permission, and allow approving PRs.

", "example": { - "key_id": "012345678912345678", - "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" + "default_workflow_permissions": "read", + "can_approve_pull_request_reviews": true }, "schema": { - "title": "ActionsPublicKey", - "description": "The public key used for setting Actions Secrets.", "type": "object", "properties": { - "key_id": { - "description": "The identifier for the key.", - "type": "string", - "examples": [ - "1234567" - ] - }, - "key": { - "description": "The Base64 encoded public key.", - "type": "string", - "examples": [ - "hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=" - ] - }, - "id": { - "type": "integer", - "examples": [ - 2 - ] - }, - "url": { - "type": "string", - "examples": [ - "https://api.github.com/user/keys/2" - ] - }, - "title": { + "default_workflow_permissions": { "type": "string", - "examples": [ - "ssh-rsa AAAAB3NzaC1yc2EAAA" + "description": "The default workflow permissions granted to the GITHUB_TOKEN when running workflows.", + "enum": [ + "read", + "write" ] }, - "created_at": { - "type": "string", - "examples": [ - "2011-01-26T19:01:12Z" - ] + "can_approve_pull_request_reviews": { + "type": "boolean", + "description": "Whether GitHub Actions can approve pull requests. Enabling this can be a security risk." } }, "required": [ - "key_id", - "key" + "default_workflow_permissions", + "can_approve_pull_request_reviews" ] } } } ], "previews": [], - "descriptionHTML": "

Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.

\n

Anyone with read access to the repository can use this endpoint.

\n

If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", + "descriptionHTML": "

Gets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in an organization,\nas well as whether GitHub Actions can submit approving pull request reviews. For more information, see\n\"Setting the permissions of the GITHUB_TOKEN for your organization.\"

\n

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -12296,24 +11963,95 @@ }, { "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/secrets/{secret_name}", - "title": "Get a repository secret", + "verb": "put", + "requestPath": "/orgs/{org}/actions/permissions/workflow", + "title": "Set default workflow permissions for an organization", "category": "actions", - "subcategory": "secrets", + "subcategory": "permissions", "parameters": [ { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", "in": "path", "required": true, "schema": { "type": "string" } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "default_workflow_permissions", + "in": "body", + "description": "

The default workflow permissions granted to the GITHUB_TOKEN when running workflows.

", + "enum": [ + "read", + "write" + ] }, { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", + "type": "boolean", + "name": "can_approve_pull_request_reviews", + "in": "body", + "description": "

Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.

" + } + ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Administration\" organization permissions": "write" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Give read-only permission, and allow approving PRs.", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "default_workflow_permissions": "read", + "can_approve_pull_request_reviews": true + }, + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "204", + "description": "

Success response

" + } + } + ], + "previews": [], + "descriptionHTML": "

Sets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in an organization, and sets if GitHub Actions\ncan submit approving pull request reviews. For more information, see\n\"Setting the permissions of the GITHUB_TOKEN for your organization.\"

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "

Success response

" + }, + { + "httpStatusCode": "409", + "description": "

Conflict response when changing a setting is prevented by the owning enterprise

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/actions/permissions", + "title": "Get GitHub Actions permissions for a repository", + "category": "actions", + "subcategory": "permissions", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", "in": "path", "required": true, "schema": { @@ -12321,8 +12059,8 @@ } }, { - "name": "secret_name", - "description": "

The name of the secret.

", + "name": "repo", + "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", "in": "path", "required": true, "schema": { @@ -12337,7 +12075,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Secrets\" repository permissions": "read" + "\"Administration\" repository permissions": "read" } ] }, @@ -12349,8 +12087,7 @@ "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", - "repo": "REPO", - "secret_name": "SECRET_NAME" + "repo": "REPO" } }, "response": { @@ -12358,42 +12095,40 @@ "contentType": "application/json", "description": "

Response

", "example": { - "name": "GH_TOKEN", - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z" - }, - "schema": { - "title": "Actions Secret", - "description": "Set secrets for GitHub Actions.", + "enabled": true, + "allowed_actions": "selected", + "selected_actions_url": "https://api.github.com/repositories/42/actions/permissions/selected-actions" + }, + "schema": { "type": "object", "properties": { - "name": { - "description": "The name of the secret.", - "type": "string", - "examples": [ - "SECRET_TOKEN" - ] + "enabled": { + "type": "boolean", + "description": "Whether GitHub Actions is enabled on the repository." }, - "created_at": { + "allowed_actions": { "type": "string", - "format": "date-time" + "description": "The permissions policy that controls the actions and reusable workflows that are allowed to run.", + "enum": [ + "all", + "local_only", + "selected" + ] }, - "updated_at": { + "selected_actions_url": { "type": "string", - "format": "date-time" + "description": "The API URL to use to get or set the actions and reusable workflows that are allowed to run, when `allowed_actions` is set to `selected`." } }, "required": [ - "name", - "created_at", - "updated_at" + "enabled" ] } } } ], "previews": [], - "descriptionHTML": "

Gets a single repository secret without revealing its encrypted value.

\n

The authenticated user must have collaborator access to the repository to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", + "descriptionHTML": "

Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions and reusable workflows allowed to run in the repository.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -12404,10 +12139,10 @@ { "serverUrl": "https://api.github.com", "verb": "put", - "requestPath": "/repos/{owner}/{repo}/actions/secrets/{secret_name}", - "title": "Create or update a repository secret", + "requestPath": "/repos/{owner}/{repo}/actions/permissions", + "title": "Set GitHub Actions permissions for a repository", "category": "actions", - "subcategory": "secrets", + "subcategory": "permissions", "parameters": [ { "name": "owner", @@ -12426,31 +12161,26 @@ "schema": { "type": "string" } - }, - { - "name": "secret_name", - "description": "

The name of the secret.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } } ], "bodyParameters": [ { - "type": "string", - "name": "encrypted_value", + "type": "boolean", + "name": "enabled", "in": "body", - "description": "

Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint.

", + "description": "

Whether GitHub Actions is enabled on the repository.

", "isRequired": true }, { "type": "string", - "name": "key_id", + "name": "allowed_actions", "in": "body", - "description": "

ID of the key you used to encrypt the secret.

", - "isRequired": true + "description": "

The permissions policy that controls the actions and reusable workflows that are allowed to run.

", + "enum": [ + "all", + "local_only", + "selected" + ] } ], "progAccess": { @@ -12459,7 +12189,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Secrets\" repository permissions": "write" + "\"Administration\" repository permissions": "write" } ] }, @@ -12468,74 +12198,39 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example 1: Status Code 201", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "encrypted_value": "c2VjcmV0", - "key_id": "012345678912345678" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "secret_name": "SECRET_NAME" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response when creating a secret

", - "example": null, - "schema": { - "title": "Empty Object", - "description": "An object without any properties.", - "type": "object", - "properties": {}, - "additionalProperties": false - } - } - }, - { - "key": "204", - "request": { - "contentType": "application/json", - "description": "Example 2: Status Code 204", + "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "encrypted_value": "c2VjcmV0", - "key_id": "012345678912345678" + "enabled": true, + "allowed_actions": "selected" }, "parameters": { "owner": "OWNER", - "repo": "REPO", - "secret_name": "SECRET_NAME" + "repo": "REPO" } }, "response": { "statusCode": "204", - "description": "

Response when updating a secret

" + "description": "

Response

" } } ], "previews": [], - "descriptionHTML": "

Creates or updates a repository secret with an encrypted value. Encrypt your secret using\nLibSodium. For more information, see \"Encrypting secrets for the REST API.\"

\n

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", + "descriptionHTML": "

Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions in the repository.

\n

If the repository belongs to an organization or enterprise that has set restrictive permissions at the organization or enterprise levels, such as allowed_actions to selected actions, then you cannot override them for the repository.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Response when creating a secret

" - }, { "httpStatusCode": "204", - "description": "

Response when updating a secret

" + "description": "

No Content

" } ] }, { "serverUrl": "https://api.github.com", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/actions/secrets/{secret_name}", - "title": "Delete a repository secret", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/actions/permissions/access", + "title": "Get the level of access for workflows outside of the repository", "category": "actions", - "subcategory": "secrets", + "subcategory": "permissions", "parameters": [ { "name": "owner", @@ -12554,15 +12249,6 @@ "schema": { "type": "string" } - }, - { - "name": "secret_name", - "description": "

The name of the secret.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } } ], "bodyParameters": [], @@ -12572,7 +12258,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Secrets\" repository permissions": "write" + "\"Administration\" repository permissions": "read" } ] }, @@ -12584,32 +12270,53 @@ "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", - "repo": "REPO", - "secret_name": "SECRET_NAME" + "repo": "REPO" } }, "response": { - "statusCode": "204", - "description": "

Response

" + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "access_level": "organization" + }, + "schema": { + "type": "object", + "properties": { + "access_level": { + "type": "string", + "description": "Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the\nrepository.\n\n`none` means the access is only possible from workflows in this repository. `user` level access allows sharing across user owned private repositories only. `organization` level access allows sharing across the organization. `enterprise` level access allows sharing across the enterprise.", + "enum": [ + "none", + "user", + "organization", + "enterprise" + ] + } + }, + "required": [ + "access_level" + ] + } } } ], "previews": [], - "descriptionHTML": "

Deletes a secret in a repository using the secret name.

\n

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", + "descriptionHTML": "

Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal and private repositories.\nFor more information, see \"Allowing access to components in a private repository\" and\n\"Allowing access to components in an internal repository.\"

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { - "httpStatusCode": "204", - "description": "

No Content

" + "httpStatusCode": "200", + "description": "

OK

" } ] }, { "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/secrets", - "title": "List environment secrets", + "verb": "put", + "requestPath": "/repos/{owner}/{repo}/actions/permissions/access", + "title": "Set the level of access for workflows outside of the repository", "category": "actions", - "subcategory": "secrets", + "subcategory": "permissions", "parameters": [ { "name": "owner", @@ -12628,43 +12335,30 @@ "schema": { "type": "string" } - }, - { - "name": "environment_name", - "in": "path", - "required": true, - "description": "

The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F.

", - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, + } + ], + "bodyParameters": [ { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } + "type": "string", + "name": "access_level", + "in": "body", + "description": "

Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the\nrepository.

\n

none means the access is only possible from workflows in this repository. user level access allows sharing across user owned private repositories only. organization level access allows sharing across the organization. enterprise level access allows sharing across the enterprise.

", + "isRequired": true, + "enum": [ + "none", + "user", + "organization", + "enterprise" + ] } ], - "bodyParameters": [], "progAccess": { "userToServerRest": true, "serverToServer": true, "fineGrainedPat": true, "permissions": [ { - "\"Environments\" repository permissions": "read" + "\"Administration\" repository permissions": "write" } ] }, @@ -12672,94 +12366,39 @@ { "key": "default", "request": { + "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "access_level": "organization" + }, "parameters": { "owner": "OWNER", - "repo": "REPO", - "environment_name": "ENVIRONMENT_NAME" + "repo": "REPO" } }, "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "total_count": 2, - "secrets": [ - { - "name": "GH_TOKEN", - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z" - }, - { - "name": "GIST_ID", - "created_at": "2020-01-10T10:59:22Z", - "updated_at": "2020-01-11T11:59:22Z" - } - ] - }, - "schema": { - "type": "object", - "required": [ - "total_count", - "secrets" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "secrets": { - "type": "array", - "items": { - "title": "Actions Secret", - "description": "Set secrets for GitHub Actions.", - "type": "object", - "properties": { - "name": { - "description": "The name of the secret.", - "type": "string", - "examples": [ - "SECRET_TOKEN" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "name", - "created_at", - "updated_at" - ] - } - } - } - } + "statusCode": "204", + "description": "

Response

" } } ], "previews": [], - "descriptionHTML": "

Lists all secrets available in an environment without revealing their\nencrypted values.

\n

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", + "descriptionHTML": "

Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal and private repositories.\nFor more information, see \"Allowing access to components in a private repository\" and\n\"Allowing access to components in an internal repository.\"

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { - "httpStatusCode": "200", - "description": "

OK

" + "httpStatusCode": "204", + "description": "

No Content

" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/secrets/public-key", - "title": "Get an environment public key", + "requestPath": "/repos/{owner}/{repo}/actions/permissions/artifact-and-log-retention", + "title": "Get artifact and log retention settings for a repository", "category": "actions", - "subcategory": "secrets", + "subcategory": "permissions", "parameters": [ { "name": "owner", @@ -12778,15 +12417,6 @@ "schema": { "type": "string" } - }, - { - "name": "environment_name", - "in": "path", - "required": true, - "description": "

The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F.

", - "schema": { - "type": "string" - } } ], "bodyParameters": [], @@ -12796,7 +12426,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Environments\" repository permissions": "read" + "\"Administration\" repository permissions": "read" } ] }, @@ -12808,8 +12438,7 @@ "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", - "repo": "REPO", - "environment_name": "ENVIRONMENT_NAME" + "repo": "REPO" } }, "response": { @@ -12817,77 +12446,49 @@ "contentType": "application/json", "description": "

Response

", "example": { - "key_id": "012345678912345678", - "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" + "days": 90, + "maximum_allowed_days": 365 }, "schema": { - "title": "ActionsPublicKey", - "description": "The public key used for setting Actions Secrets.", "type": "object", "properties": { - "key_id": { - "description": "The identifier for the key.", - "type": "string", - "examples": [ - "1234567" - ] - }, - "key": { - "description": "The Base64 encoded public key.", - "type": "string", - "examples": [ - "hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=" - ] - }, - "id": { + "days": { "type": "integer", - "examples": [ - 2 - ] - }, - "url": { - "type": "string", - "examples": [ - "https://api.github.com/user/keys/2" - ] - }, - "title": { - "type": "string", - "examples": [ - "ssh-rsa AAAAB3NzaC1yc2EAAA" - ] + "description": "The number of days artifacts and logs are retained" }, - "created_at": { - "type": "string", - "examples": [ - "2011-01-26T19:01:12Z" - ] + "maximum_allowed_days": { + "type": "integer", + "description": "The maximum number of days that can be configured" } }, "required": [ - "key_id", - "key" + "days", + "maximum_allowed_days" ] } } } ], "previews": [], - "descriptionHTML": "

Get the public key for an environment, which you need to encrypt environment\nsecrets. You need to encrypt a secret before you can create or update secrets.

\n

Anyone with read access to the repository can use this endpoint.

\n

If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", + "descriptionHTML": "

Gets artifact and log retention settings for a repository.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" } ] }, { "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}", - "title": "Get an environment secret", + "verb": "put", + "requestPath": "/repos/{owner}/{repo}/actions/permissions/artifact-and-log-retention", + "title": "Set artifact and log retention settings for a repository", "category": "actions", - "subcategory": "secrets", + "subcategory": "permissions", "parameters": [ { "name": "owner", @@ -12906,34 +12507,24 @@ "schema": { "type": "string" } - }, - { - "name": "environment_name", - "in": "path", - "required": true, - "description": "

The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F.

", - "schema": { - "type": "string" - } - }, + } + ], + "bodyParameters": [ { - "name": "secret_name", - "description": "

The name of the secret.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } + "type": "integer", + "name": "days", + "in": "body", + "description": "

The number of days to retain artifacts and logs

", + "isRequired": true } ], - "bodyParameters": [], "progAccess": { "userToServerRest": true, "serverToServer": true, "fineGrainedPat": true, "permissions": [ { - "\"Environments\" repository permissions": "read" + "\"Administration\" repository permissions": "write" } ] }, @@ -12941,70 +12532,47 @@ { "key": "default", "request": { - "description": "Example", + "contentType": "application/json", + "description": "Set retention days", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "days": 90 + }, "parameters": { "owner": "OWNER", - "repo": "REPO", - "environment_name": "ENVIRONMENT_NAME", - "secret_name": "SECRET_NAME" + "repo": "REPO" } }, "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "name": "GH_TOKEN", - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z" - }, - "schema": { - "title": "Actions Secret", - "description": "Set secrets for GitHub Actions.", - "type": "object", - "properties": { - "name": { - "description": "The name of the secret.", - "type": "string", - "examples": [ - "SECRET_TOKEN" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "name", - "created_at", - "updated_at" - ] - } + "statusCode": "204", + "description": "

Empty response for successful settings update

" } } ], "previews": [], - "descriptionHTML": "

Gets a single environment secret without revealing its encrypted value.

\n

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", + "descriptionHTML": "

Sets artifact and log retention settings for a repository.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { - "httpStatusCode": "200", - "description": "

OK

" + "httpStatusCode": "204", + "description": "

Empty response for successful settings update

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" } ] }, { "serverUrl": "https://api.github.com", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}", - "title": "Create or update an environment secret", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/actions/permissions/fork-pr-contributor-approval", + "title": "Get fork PR contributor approval permissions for a repository", "category": "actions", - "subcategory": "secrets", + "subcategory": "permissions", "parameters": [ { "name": "owner", @@ -13023,49 +12591,16 @@ "schema": { "type": "string" } - }, - { - "name": "environment_name", - "in": "path", - "required": true, - "description": "

The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F.

", - "schema": { - "type": "string" - } - }, - { - "name": "secret_name", - "description": "

The name of the secret.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "encrypted_value", - "in": "body", - "description": "

Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an environment public key endpoint.

", - "isRequired": true - }, - { - "type": "string", - "name": "key_id", - "in": "body", - "description": "

ID of the key you used to encrypt the secret.

", - "isRequired": true } ], + "bodyParameters": [], "progAccess": { "userToServerRest": true, "serverToServer": true, "fineGrainedPat": true, "permissions": [ { - "\"Environments\" repository permissions": "write" + "\"Administration\" repository permissions": "read" } ] }, @@ -13073,77 +12608,60 @@ { "key": "default", "request": { - "contentType": "application/json", - "description": "Example 1: Status Code 201", + "description": "Example", "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "encrypted_value": "c2VjcmV0", - "key_id": "012345678912345678" - }, "parameters": { "owner": "OWNER", - "repo": "REPO", - "environment_name": "ENVIRONMENT_NAME", - "secret_name": "SECRET_NAME" + "repo": "REPO" } }, "response": { - "statusCode": "201", + "statusCode": "200", "contentType": "application/json", - "description": "

Response when creating a secret

", - "example": null, + "description": "

Response

", + "example": { + "approval_policy": "first_time_contributors" + }, "schema": { - "title": "Empty Object", - "description": "An object without any properties.", "type": "object", - "properties": {}, - "additionalProperties": false - } - } - }, - { - "key": "204", - "request": { - "contentType": "application/json", - "description": "Example 2: Status Code 204", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "encrypted_value": "c2VjcmV0", - "key_id": "012345678912345678" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "environment_name": "ENVIRONMENT_NAME", - "secret_name": "SECRET_NAME" + "properties": { + "approval_policy": { + "type": "string", + "enum": [ + "first_time_contributors_new_to_github", + "first_time_contributors", + "all_external_contributors" + ], + "description": "The policy that controls when fork PR workflows require approval from a maintainer." + } + }, + "required": [ + "approval_policy" + ] } - }, - "response": { - "statusCode": "204", - "description": "

Response when updating a secret

" } } ], "previews": [], - "descriptionHTML": "

Creates or updates an environment secret with an encrypted value. Encrypt your secret using\nLibSodium. For more information, see \"Encrypting secrets for the REST API.\"

\n

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", + "descriptionHTML": "

Gets the fork PR contributor approval policy for a repository.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { - "httpStatusCode": "201", - "description": "

Response when creating a secret

" + "httpStatusCode": "200", + "description": "

OK

" }, { - "httpStatusCode": "204", - "description": "

Response when updating a secret

" + "httpStatusCode": "404", + "description": "

Resource not found

" } ] }, { "serverUrl": "https://api.github.com", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}", - "title": "Delete an environment secret", + "verb": "put", + "requestPath": "/repos/{owner}/{repo}/actions/permissions/fork-pr-contributor-approval", + "title": "Set fork PR contributor approval permissions for a repository", "category": "actions", - "subcategory": "secrets", + "subcategory": "permissions", "parameters": [ { "name": "owner", @@ -13162,34 +12680,29 @@ "schema": { "type": "string" } - }, - { - "name": "environment_name", - "in": "path", - "required": true, - "description": "

The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F.

", - "schema": { - "type": "string" - } - }, + } + ], + "bodyParameters": [ { - "name": "secret_name", - "description": "

The name of the secret.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } + "type": "string", + "name": "approval_policy", + "in": "body", + "description": "

The policy that controls when fork PR workflows require approval from a maintainer.

", + "isRequired": true, + "enum": [ + "first_time_contributors_new_to_github", + "first_time_contributors", + "all_external_contributors" + ] } ], - "bodyParameters": [], "progAccess": { "userToServerRest": true, "serverToServer": true, "fineGrainedPat": true, "permissions": [ { - "\"Environments\" repository permissions": "write" + "\"Administration\" repository permissions": "write" } ] }, @@ -13197,43 +12710,51 @@ { "key": "default", "request": { - "description": "Example", + "contentType": "application/json", + "description": "Set approval policy to first time contributors", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "approval_policy": "first_time_contributors" + }, "parameters": { "owner": "OWNER", - "repo": "REPO", - "environment_name": "ENVIRONMENT_NAME", - "secret_name": "SECRET_NAME" + "repo": "REPO" } }, "response": { "statusCode": "204", - "description": "

Default response

" + "description": "

Response

" } } ], "previews": [], - "descriptionHTML": "

Deletes a secret in an environment using the secret name.

\n

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", + "descriptionHTML": "

Sets the fork PR contributor approval policy for a repository.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", - "description": "

Default response

" + "description": "

No Content

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" } ] - } - ], - "self-hosted-runner-groups": [ + }, { "serverUrl": "https://api.github.com", "verb": "get", - "requestPath": "/enterprises/{enterprise}/actions/runner-groups", - "title": "List self-hosted runner groups for an enterprise", + "requestPath": "/repos/{owner}/{repo}/actions/permissions/fork-pr-workflows-private-repos", + "title": "Get private repo fork PR workflow settings for a repository", "category": "actions", - "subcategory": "self-hosted-runner-groups", + "subcategory": "permissions", "parameters": [ { - "name": "enterprise", - "description": "

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

", + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", "in": "path", "required": true, "schema": { @@ -13241,28 +12762,10 @@ } }, { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "visible_to_organization", - "description": "

Only return runner groups that are allowed to be used by this organization.

", - "in": "query", - "required": false, + "name": "repo", + "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", + "in": "path", + "required": true, "schema": { "type": "string" } @@ -13270,10 +12773,14 @@ ], "bodyParameters": [], "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Administration\" repository permissions": "read" + } + ] }, "codeExamples": [ { @@ -13282,7 +12789,8 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "enterprise": "ENTERPRISE" + "owner": "OWNER", + "repo": "REPO" } }, "response": { @@ -13290,148 +12798,78 @@ "contentType": "application/json", "description": "

Response

", "example": { - "total_count": 3, - "runner_groups": [ - { - "id": 1, - "name": "Default", - "visibility": "all", - "default": true, - "runners_url": "https://api.github.com/enterprises/octo-corp/actions/runner_groups/1/runners", - "allows_public_repositories": false, - "restricted_to_workflows": false, - "selected_workflows": [], - "workflow_restrictions_read_only": false - }, - { - "id": 2, - "name": "octo-runner-group", - "visibility": "selected", - "default": false, - "selected_organizations_url": "https://api.github.com/enterprises/octo-corp/actions/runner_groups/2/organizations", - "runners_url": "https://api.github.com/enterprises/octo-corp/actions/runner_groups/2/runners", - "allows_public_repositories": true, - "restricted_to_workflows": true, - "selected_workflows": [ - "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" - ], - "workflow_restrictions_read_only": false - }, - { - "id": 3, - "name": "expensive-hardware", - "visibility": "private", - "default": false, - "runners_url": "https://api.github.com/enterprises/octo-corp/actions/runner_groups/3/runners", - "allows_public_repositories": true, - "restricted_to_workflows": false, - "selected_workflows": [ - "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" - ], - "workflow_restrictions_read_only": false - } - ] + "run_workflows_from_fork_pull_requests": true, + "send_write_tokens_to_workflows": false, + "send_secrets_and_variables": false, + "require_approval_for_fork_pr_workflows": true }, "schema": { "type": "object", + "required": [ + "run_workflows_from_fork_pull_requests", + "send_write_tokens_to_workflows", + "send_secrets_and_variables", + "require_approval_for_fork_pr_workflows" + ], "properties": { - "total_count": { - "type": "number" + "run_workflows_from_fork_pull_requests": { + "type": "boolean", + "description": "Whether workflows triggered by pull requests from forks are allowed to run on private repositories." }, - "runner_groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "number" - }, - "name": { - "type": "string" - }, - "visibility": { - "type": "string" - }, - "default": { - "type": "boolean" - }, - "selected_organizations_url": { - "type": "string" - }, - "runners_url": { - "type": "string" - }, - "hosted_runners_url": { - "type": "string" - }, - "network_configuration_id": { - "description": "The identifier of a hosted compute network configuration.", - "type": "string" - }, - "allows_public_repositories": { - "type": "boolean" - }, - "workflow_restrictions_read_only": { - "description": "If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.", - "type": "boolean", - "default": false - }, - "restricted_to_workflows": { - "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", - "type": "boolean", - "default": false - }, - "selected_workflows": { - "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", - "type": "array", - "items": { - "type": "string", - "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", - "examples": [ - "octo-org/octo-repo/.github/workflows/deploy.yaml@main" - ] - } - } - }, - "required": [ - "id", - "name", - "visibility", - "allows_public_repositories", - "default", - "runners_url" - ] - } + "send_write_tokens_to_workflows": { + "type": "boolean", + "description": "Whether GitHub Actions can create pull requests or submit approving pull request reviews from a workflow triggered by a fork pull request." + }, + "send_secrets_and_variables": { + "type": "boolean", + "description": "Whether to make secrets and variables available to workflows triggered by pull requests from forks." + }, + "require_approval_for_fork_pr_workflows": { + "type": "boolean", + "description": "Whether workflows triggered by pull requests from forks require approval from a repository administrator to run." } - }, - "required": [ - "total_count", - "runner_groups" - ] + } } } } ], "previews": [], - "descriptionHTML": "

Lists all self-hosted runner groups for an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", + "descriptionHTML": "

Gets the settings for whether workflows from fork pull requests can run on a private repository.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" } ] }, { "serverUrl": "https://api.github.com", - "verb": "post", - "requestPath": "/enterprises/{enterprise}/actions/runner-groups", - "title": "Create a self-hosted runner group for an enterprise", + "verb": "put", + "requestPath": "/repos/{owner}/{repo}/actions/permissions/fork-pr-workflows-private-repos", + "title": "Set private repo fork PR workflow settings for a repository", "category": "actions", - "subcategory": "self-hosted-runner-groups", + "subcategory": "permissions", "parameters": [ { - "name": "enterprise", - "description": "

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

", + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", "in": "path", "required": true, "schema": { @@ -13441,66 +12879,40 @@ ], "bodyParameters": [ { - "type": "string", - "name": "name", + "type": "boolean", + "name": "run_workflows_from_fork_pull_requests", "in": "body", - "description": "

Name of the runner group.

", + "description": "

Whether workflows triggered by pull requests from forks are allowed to run on private repositories.

", "isRequired": true }, - { - "type": "string", - "name": "visibility", - "in": "body", - "description": "

Visibility of a runner group. You can select all organizations or select individual organization.

", - "enum": [ - "selected", - "all" - ] - }, - { - "type": "array of integers", - "name": "selected_organization_ids", - "in": "body", - "description": "

List of organization IDs that can access the runner group.

" - }, - { - "type": "array of integers", - "name": "runners", - "in": "body", - "description": "

List of runner IDs to add to the runner group.

" - }, { "type": "boolean", - "name": "allows_public_repositories", + "name": "send_write_tokens_to_workflows", "in": "body", - "description": "

Whether the runner group can be used by public repositories.

", - "default": false + "description": "

Whether GitHub Actions can create pull requests or submit approving pull request reviews from a workflow triggered by a fork pull request.

" }, { "type": "boolean", - "name": "restricted_to_workflows", - "in": "body", - "description": "

If true, the runner group will be restricted to running only the workflows specified in the selected_workflows array.

", - "default": false - }, - { - "type": "array of strings", - "name": "selected_workflows", + "name": "send_secrets_and_variables", "in": "body", - "description": "

List of workflows the runner group should be allowed to run. This setting will be ignored unless restricted_to_workflows is set to true.

" + "description": "

Whether to make secrets and variables available to workflows triggered by pull requests from forks.

" }, { - "type": "string", - "name": "network_configuration_id", + "type": "boolean", + "name": "require_approval_for_fork_pr_workflows", "in": "body", - "description": "

The identifier of a hosted compute network configuration.

" + "description": "

Whether workflows triggered by pull requests from forks require approval from a repository administrator to run.

" } ], "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Administration\" repository permissions": "write" + } + ] }, "codeExamples": [ { @@ -13510,126 +12922,50 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "name": "Expensive hardware runners", - "visibility": "selected", - "selected_organization_ids": [ - 32, - 91 - ], - "runners": [ - 9, - 2 - ] + "run_workflows_from_fork_pull_requests": true, + "send_write_tokens_to_workflows": false, + "send_secrets_and_variables": false, + "require_approval_for_fork_pr_workflows": true }, "parameters": { - "enterprise": "ENTERPRISE" + "owner": "OWNER", + "repo": "REPO" } }, "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 2, - "name": "octo-runner-group", - "visibility": "selected", - "default": false, - "selected_organizations_url": "https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/organizations", - "runners_url": "https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/runners", - "hosted_runners_url": "https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/hosted-runners", - "network_configuration_id": "EC486D5D793175D7E3B29C27318D5C1AAE49A7833FC85F2E82C3D2C54AC7D3BA", - "allows_public_repositories": false, - "restricted_to_workflows": true, - "selected_workflows": [ - "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" - ], - "workflow_restrictions_read_only": false - }, - "schema": { - "type": "object", - "properties": { - "id": { - "type": "number" - }, - "name": { - "type": "string" - }, - "visibility": { - "type": "string" - }, - "default": { - "type": "boolean" - }, - "selected_organizations_url": { - "type": "string" - }, - "runners_url": { - "type": "string" - }, - "hosted_runners_url": { - "type": "string" - }, - "network_configuration_id": { - "description": "The identifier of a hosted compute network configuration.", - "type": "string" - }, - "allows_public_repositories": { - "type": "boolean" - }, - "workflow_restrictions_read_only": { - "description": "If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.", - "type": "boolean", - "default": false - }, - "restricted_to_workflows": { - "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", - "type": "boolean", - "default": false - }, - "selected_workflows": { - "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", - "type": "array", - "items": { - "type": "string", - "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", - "examples": [ - "octo-org/octo-repo/.github/workflows/deploy.yaml@main" - ] - } - } - }, - "required": [ - "id", - "name", - "visibility", - "allows_public_repositories", - "default", - "runners_url" - ] - } + "statusCode": "204", + "description": "

Empty response for successful settings update

" } } ], "previews": [], - "descriptionHTML": "

Creates a new self-hosted runner group for an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", + "descriptionHTML": "

Sets the settings for whether workflows from fork pull requests can run on a private repository.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { - "httpStatusCode": "201", - "description": "

Created

" + "httpStatusCode": "204", + "description": "

Empty response for successful settings update

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", - "requestPath": "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}", - "title": "Get a self-hosted runner group for an enterprise", + "requestPath": "/repos/{owner}/{repo}/actions/permissions/selected-actions", + "title": "Get allowed actions and reusable workflows for a repository", "category": "actions", - "subcategory": "self-hosted-runner-groups", + "subcategory": "permissions", "parameters": [ { - "name": "enterprise", - "description": "

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

", + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", "in": "path", "required": true, "schema": { @@ -13637,21 +12973,25 @@ } }, { - "name": "runner_group_id", - "description": "

Unique identifier of the self-hosted runner group.

", + "name": "repo", + "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" } } ], "bodyParameters": [], "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Administration\" repository permissions": "read" + } + ] }, "codeExamples": [ { @@ -13660,8 +13000,8 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "enterprise": "ENTERPRISE", - "runner_group_id": "RUNNER_GROUP_ID" + "owner": "OWNER", + "repo": "REPO" } }, "response": { @@ -13669,88 +13009,38 @@ "contentType": "application/json", "description": "

Response

", "example": { - "id": 2, - "name": "octo-runner-group", - "visibility": "selected", - "default": false, - "selected_organizations_url": "https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/organizations", - "runners_url": "https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/runners", - "hosted_runners_url": "https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/hosted-runners", - "network_configuration_id": "EC486D5D793175D7E3B29C27318D5C1AAE49A7833FC85F2E82C3D2C54AC7D3BA", - "allows_public_repositories": false, - "restricted_to_workflows": true, - "selected_workflows": [ - "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" - ], - "workflow_restrictions_read_only": false + "github_owned_allowed": true, + "verified_allowed": false, + "patterns_allowed": [ + "monalisa/octocat@*", + "docker/*" + ] }, "schema": { "type": "object", "properties": { - "id": { - "type": "number" - }, - "name": { - "type": "string" - }, - "visibility": { - "type": "string" - }, - "default": { - "type": "boolean" - }, - "selected_organizations_url": { - "type": "string" - }, - "runners_url": { - "type": "string" - }, - "hosted_runners_url": { - "type": "string" - }, - "network_configuration_id": { - "description": "The identifier of a hosted compute network configuration.", - "type": "string" - }, - "allows_public_repositories": { - "type": "boolean" - }, - "workflow_restrictions_read_only": { - "description": "If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.", + "github_owned_allowed": { "type": "boolean", - "default": false + "description": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization." }, - "restricted_to_workflows": { - "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", + "verified_allowed": { "type": "boolean", - "default": false + "description": "Whether actions from GitHub Marketplace verified creators are allowed. Set to `true` to allow all actions by GitHub Marketplace verified creators." }, - "selected_workflows": { - "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", + "patterns_allowed": { "type": "array", + "description": "Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.", "items": { - "type": "string", - "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", - "examples": [ - "octo-org/octo-repo/.github/workflows/deploy.yaml@main" - ] + "type": "string" } } - }, - "required": [ - "id", - "name", - "visibility", - "allows_public_repositories", - "default", - "runners_url" - ] + } } } } ], "previews": [], - "descriptionHTML": "

Gets a specific self-hosted runner group for an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", + "descriptionHTML": "

Gets the settings for selected actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for a repository.\"

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -13760,15 +13050,15 @@ }, { "serverUrl": "https://api.github.com", - "verb": "patch", - "requestPath": "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}", - "title": "Update a self-hosted runner group for an enterprise", + "verb": "put", + "requestPath": "/repos/{owner}/{repo}/actions/permissions/selected-actions", + "title": "Set allowed actions for a repository", "category": "actions", - "subcategory": "self-hosted-runner-groups", + "subcategory": "permissions", "parameters": [ { - "name": "enterprise", - "description": "

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

", + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", "in": "path", "required": true, "schema": { @@ -13776,169 +13066,163 @@ } }, { - "name": "runner_group_id", - "description": "

Unique identifier of the self-hosted runner group.

", + "name": "repo", + "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" } } ], "bodyParameters": [ - { - "type": "string", - "name": "name", - "in": "body", - "description": "

Name of the runner group.

" - }, - { - "type": "string", - "name": "visibility", - "in": "body", - "description": "

Visibility of a runner group. You can select all organizations or select individual organizations.

", - "enum": [ - "selected", - "all" - ], - "default": "all" - }, { "type": "boolean", - "name": "allows_public_repositories", + "name": "github_owned_allowed", "in": "body", - "description": "

Whether the runner group can be used by public repositories.

", - "default": false + "description": "

Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.

" }, { "type": "boolean", - "name": "restricted_to_workflows", + "name": "verified_allowed", "in": "body", - "description": "

If true, the runner group will be restricted to running only the workflows specified in the selected_workflows array.

", - "default": false + "description": "

Whether actions from GitHub Marketplace verified creators are allowed. Set to true to allow all actions by GitHub Marketplace verified creators.

" }, { "type": "array of strings", - "name": "selected_workflows", - "in": "body", - "description": "

List of workflows the runner group should be allowed to run. This setting will be ignored unless restricted_to_workflows is set to true.

" - }, - { - "type": "string or null", - "name": "network_configuration_id", + "name": "patterns_allowed", "in": "body", - "description": "

The identifier of a hosted compute network configuration.

" + "description": "

Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.

" } ], "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Administration\" repository permissions": "write" + } + ] }, "codeExamples": [ { - "key": "default", + "key": "selected_actions", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "name": "Expensive hardware runners", - "visibility": "selected" + "github_owned_allowed": true, + "verified_allowed": false, + "patterns_allowed": [ + "monalisa/octocat@*", + "docker/*" + ] }, "parameters": { - "enterprise": "ENTERPRISE", - "runner_group_id": "RUNNER_GROUP_ID" + "owner": "OWNER", + "repo": "REPO" + } + }, + "response": { + "statusCode": "204", + "description": "

Response

" + } + } + ], + "previews": [], + "descriptionHTML": "

Sets the actions that are allowed in a repository. To use this endpoint, the repository permission policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for a repository.\"

\n

If the repository belongs to an organization or enterprise that has selected actions set at the organization or enterprise levels, then you cannot override any of the allowed actions settings and reusable workflows settings.

\n

To use the patterns_allowed setting for private repositories, the repository must belong to an enterprise. If the repository does not belong to an enterprise, then the patterns_allowed setting only applies to public repositories.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "

No Content

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/actions/permissions/workflow", + "title": "Get default workflow permissions for a repository", + "category": "actions", + "subcategory": "permissions", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Administration\" repository permissions": "read" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "

Response

", + "description": "

Give read-only permission, and allow approving PRs.

", "example": { - "id": 2, - "name": "Expensive hardware runners", - "visibility": "selected", - "default": false, - "selected_organizations_url": "https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/organizations", - "runners_url": "https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/runners", - "hosted_runners_url": "https://api.github.com/enterprises/octo-corp/actions/runner_groups/2/hosted-runners", - "network_configuration_id": "EC486D5D793175D7E3B29C27318D5C1AAE49A7833FC85F2E82C3D2C54AC7D3BA", - "allows_public_repositories": true, - "restricted_to_workflows": false, - "selected_workflows": [ - "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" - ], - "workflow_restrictions_read_only": false + "default_workflow_permissions": "read", + "can_approve_pull_request_reviews": true }, "schema": { "type": "object", "properties": { - "id": { - "type": "number" - }, - "name": { - "type": "string" - }, - "visibility": { - "type": "string" - }, - "default": { - "type": "boolean" - }, - "selected_organizations_url": { - "type": "string" - }, - "runners_url": { - "type": "string" - }, - "hosted_runners_url": { - "type": "string" - }, - "network_configuration_id": { - "description": "The identifier of a hosted compute network configuration.", - "type": "string" - }, - "allows_public_repositories": { - "type": "boolean" - }, - "workflow_restrictions_read_only": { - "description": "If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.", - "type": "boolean", - "default": false + "default_workflow_permissions": { + "type": "string", + "description": "The default workflow permissions granted to the GITHUB_TOKEN when running workflows.", + "enum": [ + "read", + "write" + ] }, - "restricted_to_workflows": { - "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", + "can_approve_pull_request_reviews": { "type": "boolean", - "default": false - }, - "selected_workflows": { - "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", - "type": "array", - "items": { - "type": "string", - "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", - "examples": [ - "octo-org/octo-repo/.github/workflows/deploy.yaml@main" - ] - } + "description": "Whether GitHub Actions can approve pull requests. Enabling this can be a security risk." } }, "required": [ - "id", - "name", - "visibility", - "allows_public_repositories", - "default", - "runners_url" + "default_workflow_permissions", + "can_approve_pull_request_reviews" ] } } } ], "previews": [], - "descriptionHTML": "

Updates the name and visibility of a self-hosted runner group in an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", + "descriptionHTML": "

Gets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in a repository,\nas well as if GitHub Actions can submit approving pull request reviews.\nFor more information, see \"Setting the permissions of the GITHUB_TOKEN for your repository.\"

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -13948,15 +13232,15 @@ }, { "serverUrl": "https://api.github.com", - "verb": "delete", - "requestPath": "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}", - "title": "Delete a self-hosted runner group from an enterprise", + "verb": "put", + "requestPath": "/repos/{owner}/{repo}/actions/permissions/workflow", + "title": "Set default workflow permissions for a repository", "category": "actions", - "subcategory": "self-hosted-runner-groups", + "subcategory": "permissions", "parameters": [ { - "name": "enterprise", - "description": "

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

", + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", "in": "path", "required": true, "schema": { @@ -13964,74 +13248,97 @@ } }, { - "name": "runner_group_id", - "description": "

Unique identifier of the self-hosted runner group.

", + "name": "repo", + "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" } } ], - "bodyParameters": [], + "bodyParameters": [ + { + "type": "string", + "name": "default_workflow_permissions", + "in": "body", + "description": "

The default workflow permissions granted to the GITHUB_TOKEN when running workflows.

", + "enum": [ + "read", + "write" + ] + }, + { + "type": "boolean", + "name": "can_approve_pull_request_reviews", + "in": "body", + "description": "

Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.

" + } + ], "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Administration\" repository permissions": "write" + } + ] }, "codeExamples": [ { "key": "default", "request": { - "description": "Example", + "contentType": "application/json", + "description": "Give read-only permission, and allow approving PRs.", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "default_workflow_permissions": "read", + "can_approve_pull_request_reviews": true + }, "parameters": { - "enterprise": "ENTERPRISE", - "runner_group_id": "RUNNER_GROUP_ID" + "owner": "OWNER", + "repo": "REPO" } }, "response": { "statusCode": "204", - "description": "

Response

" + "description": "

Success response

" } } ], "previews": [], - "descriptionHTML": "

Deletes a self-hosted runner group for an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", + "descriptionHTML": "

Sets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in a repository, and sets if GitHub Actions\ncan submit approving pull request reviews.\nFor more information, see \"Setting the permissions of the GITHUB_TOKEN for your repository.\"

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", - "description": "

No Content

" + "description": "

Success response

" + }, + { + "httpStatusCode": "409", + "description": "

Conflict response when changing a setting is prevented by the owning organization or enterprise

" } ] - }, + } + ], + "secrets": [ { "serverUrl": "https://api.github.com", "verb": "get", - "requestPath": "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations", - "title": "List organization access to a self-hosted runner group in an enterprise", + "requestPath": "/orgs/{org}/actions/secrets", + "title": "List organization secrets", "category": "actions", - "subcategory": "self-hosted-runner-groups", + "subcategory": "secrets", "parameters": [ { - "name": "enterprise", - "description": "

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

", + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", "in": "path", "required": true, "schema": { "type": "string" } }, - { - "name": "runner_group_id", - "description": "

Unique identifier of the self-hosted runner group.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, { "name": "per_page", "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", @@ -14053,10 +13360,14 @@ ], "bodyParameters": [], "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Secrets\" organization permissions": "read" + } + ] }, "codeExamples": [ { @@ -14065,8 +13376,7 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "enterprise": "ENTERPRISE", - "runner_group_id": "RUNNER_GROUP_ID" + "org": "ORG" } }, "response": { @@ -14074,143 +13384,201 @@ "contentType": "application/json", "description": "

Response

", "example": { - "total_count": 1, - "organizations": [ + "total_count": 3, + "secrets": [ { - "login": "octocat", - "id": 161335, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "url": "https://api.github.com/orgs/octo-org", - "repos_url": "https://api.github.com/orgs/octo-org/repos", - "events_url": "https://api.github.com/orgs/octo-org/events", - "hooks_url": "https://api.github.com/orgs/octo-org/hooks", - "issues_url": "https://api.github.com/orgs/octo-org/issues", - "members_url": "https://api.github.com/orgs/octo-org/members{/member}", - "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization" + "name": "GIST_ID", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "private" + }, + { + "name": "DEPLOY_TOKEN", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "all" + }, + { + "name": "GH_TOKEN", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "selected", + "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/secrets/SUPER_SECRET/repositories" } ] }, "schema": { "type": "object", + "required": [ + "total_count", + "secrets" + ], "properties": { "total_count": { - "type": "number" + "type": "integer" }, - "organizations": { + "secrets": { "type": "array", "items": { - "title": "Organization Simple", - "description": "A GitHub organization.", + "title": "Actions Secret for an Organization", + "description": "Secrets for GitHub Actions for an organization.", "type": "object", "properties": { - "login": { + "name": { + "description": "The name of the secret.", "type": "string", "examples": [ - "github" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 + "SECRET_TOKEN" ] }, - "node_id": { + "created_at": { "type": "string", - "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" - ] + "format": "date-time" }, - "url": { + "updated_at": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] + "format": "date-time" }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/repos" - ] + "visibility": { + "description": "Visibility of a secret", + "enum": [ + "all", + "private", + "selected" + ], + "type": "string" }, - "events_url": { + "selected_repositories_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/orgs/github/events" - ] - }, - "hooks_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/hooks" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/issues" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/members{/member}" - ] - }, - "public_members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" - ] - }, - "avatar_url": { - "type": "string", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great organization" + "https://api.github.com/organizations/org/secrets/my_secret/repositories" ] } }, "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" + "name", + "created_at", + "updated_at", + "visibility" ] } } + } + } + } + } + ], + "previews": [], + "descriptionHTML": "

Lists all secrets available in an organization without revealing their\nencrypted values.

\n

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/actions/secrets/public-key", + "title": "Get an organization public key", + "category": "actions", + "subcategory": "secrets", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Secrets\" organization permissions": "read" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "key_id": "012345678912345678", + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" + }, + "schema": { + "title": "ActionsPublicKey", + "description": "The public key used for setting Actions Secrets.", + "type": "object", + "properties": { + "key_id": { + "description": "The identifier for the key.", + "type": "string", + "examples": [ + "1234567" + ] + }, + "key": { + "description": "The Base64 encoded public key.", + "type": "string", + "examples": [ + "hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=" + ] + }, + "id": { + "type": "integer", + "examples": [ + 2 + ] + }, + "url": { + "type": "string", + "examples": [ + "https://api.github.com/user/keys/2" + ] + }, + "title": { + "type": "string", + "examples": [ + "ssh-rsa AAAAB3NzaC1yc2EAAA" + ] + }, + "created_at": { + "type": "string", + "examples": [ + "2011-01-26T19:01:12Z" + ] + } }, "required": [ - "total_count", - "organizations" + "key_id", + "key" ] } } } ], "previews": [], - "descriptionHTML": "

Lists the organizations with access to a self-hosted runner group.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", + "descriptionHTML": "

Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.

\n

The authenticated user must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -14220,15 +13588,15 @@ }, { "serverUrl": "https://api.github.com", - "verb": "put", - "requestPath": "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations", - "title": "Set organization access for a self-hosted runner group in an enterprise", + "verb": "get", + "requestPath": "/orgs/{org}/actions/secrets/{secret_name}", + "title": "Get an organization secret", "category": "actions", - "subcategory": "self-hosted-runner-groups", + "subcategory": "secrets", "parameters": [ { - "name": "enterprise", - "description": "

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

", + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", "in": "path", "required": true, "schema": { @@ -14236,74 +13604,115 @@ } }, { - "name": "runner_group_id", - "description": "

Unique identifier of the self-hosted runner group.

", + "name": "secret_name", + "description": "

The name of the secret.

", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" } } ], - "bodyParameters": [ - { - "type": "array of integers", - "name": "selected_organization_ids", - "in": "body", - "description": "

List of organization IDs that can access the runner group.

", - "isRequired": true - } - ], + "bodyParameters": [], "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Secrets\" organization permissions": "read" + } + ] }, "codeExamples": [ { "key": "default", "request": { - "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "selected_organization_ids": [ - 32, - 91 - ] - }, "parameters": { - "enterprise": "ENTERPRISE", - "runner_group_id": "RUNNER_GROUP_ID" + "org": "ORG", + "secret_name": "SECRET_NAME" } }, "response": { - "statusCode": "204", - "description": "

Response

" + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "name": "GH_TOKEN", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "selected", + "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/secrets/SUPER_SECRET/repositories" + }, + "schema": { + "title": "Actions Secret for an Organization", + "description": "Secrets for GitHub Actions for an organization.", + "type": "object", + "properties": { + "name": { + "description": "The name of the secret.", + "type": "string", + "examples": [ + "SECRET_TOKEN" + ] + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "visibility": { + "description": "Visibility of a secret", + "enum": [ + "all", + "private", + "selected" + ], + "type": "string" + }, + "selected_repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/org/secrets/my_secret/repositories" + ] + } + }, + "required": [ + "name", + "created_at", + "updated_at", + "visibility" + ] + } } } ], "previews": [], - "descriptionHTML": "

Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", + "descriptionHTML": "

Gets a single organization secret without revealing its encrypted value.

\n

The authenticated user must have collaborator access to a repository to create, update, or read secrets

\n

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { - "httpStatusCode": "204", - "description": "

No Content

" + "httpStatusCode": "200", + "description": "

OK

" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", - "requestPath": "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations/{org_id}", - "title": "Add organization access to a self-hosted runner group in an enterprise", + "requestPath": "/orgs/{org}/actions/secrets/{secret_name}", + "title": "Create or update an organization secret", "category": "actions", - "subcategory": "self-hosted-runner-groups", + "subcategory": "secrets", "parameters": [ { - "name": "enterprise", - "description": "

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

", + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", "in": "path", "required": true, "schema": { @@ -14311,69 +13720,144 @@ } }, { - "name": "runner_group_id", - "description": "

Unique identifier of the self-hosted runner group.

", + "name": "secret_name", + "description": "

The name of the secret.

", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "encrypted_value", + "in": "body", + "description": "

Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an organization public key endpoint.

", + "isRequired": true }, { - "name": "org_id", - "description": "

The unique identifier of the organization.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } + "type": "string", + "name": "key_id", + "in": "body", + "description": "

ID of the key you used to encrypt the secret.

", + "isRequired": true + }, + { + "type": "string", + "name": "visibility", + "in": "body", + "description": "

Which type of organization repositories have access to the organization secret. selected means only the repositories specified by selected_repository_ids can access the secret.

", + "isRequired": true, + "enum": [ + "all", + "private", + "selected" + ] + }, + { + "type": "array of integers", + "name": "selected_repository_ids", + "in": "body", + "description": "

An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can manage the list of selected repositories using the List selected repositories for an organization secret, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints.

" } ], - "bodyParameters": [], "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Secrets\" organization permissions": "write" + } + ] }, "codeExamples": [ { "key": "default", "request": { - "description": "Example", + "contentType": "application/json", + "description": "Example 1: Status Code 201", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "encrypted_value": "c2VjcmV0", + "key_id": "012345678912345678", + "visibility": "selected", + "selected_repository_ids": [ + 1296269, + 1296280 + ] + }, + "parameters": { + "org": "ORG", + "secret_name": "SECRET_NAME" + } + }, + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "

Response when creating a secret

", + "example": null, + "schema": { + "title": "Empty Object", + "description": "An object without any properties.", + "type": "object", + "properties": {}, + "additionalProperties": false + } + } + }, + { + "key": "204", + "request": { + "contentType": "application/json", + "description": "Example 2: Status Code 204", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "encrypted_value": "c2VjcmV0", + "key_id": "012345678912345678", + "visibility": "selected", + "selected_repository_ids": [ + 1296269, + 1296280 + ] + }, "parameters": { - "enterprise": "ENTERPRISE", - "runner_group_id": "RUNNER_GROUP_ID", - "org_id": "ORG_ID" + "org": "ORG", + "secret_name": "SECRET_NAME" } }, "response": { "statusCode": "204", - "description": "

Response

" + "description": "

Response when updating a secret

" } } ], "previews": [], - "descriptionHTML": "

Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have visibility set to selected. For more information, see \"Create a self-hosted runner group for an enterprise.\"

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", + "descriptionHTML": "

Creates or updates an organization secret with an encrypted value. Encrypt your secret using\nLibSodium. For more information, see \"Encrypting secrets for the REST API.\"

\n

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ + { + "httpStatusCode": "201", + "description": "

Response when creating a secret

" + }, { "httpStatusCode": "204", - "description": "

No Content

" + "description": "

Response when updating a secret

" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", - "requestPath": "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations/{org_id}", - "title": "Remove organization access to a self-hosted runner group in an enterprise", + "requestPath": "/orgs/{org}/actions/secrets/{secret_name}", + "title": "Delete an organization secret", "category": "actions", - "subcategory": "self-hosted-runner-groups", + "subcategory": "secrets", "parameters": [ { - "name": "enterprise", - "description": "

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

", + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", "in": "path", "required": true, "schema": { @@ -14381,30 +13865,25 @@ } }, { - "name": "runner_group_id", - "description": "

Unique identifier of the self-hosted runner group.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "org_id", - "description": "

The unique identifier of the organization.

", + "name": "secret_name", + "description": "

The name of the secret.

", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" } } ], "bodyParameters": [], "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Secrets\" organization permissions": "write" + } + ] }, "codeExamples": [ { @@ -14413,9 +13892,8 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "enterprise": "ENTERPRISE", - "runner_group_id": "RUNNER_GROUP_ID", - "org_id": "ORG_ID" + "org": "ORG", + "secret_name": "SECRET_NAME" } }, "response": { @@ -14425,7 +13903,7 @@ } ], "previews": [], - "descriptionHTML": "

Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have visibility set to selected. For more information, see \"Create a self-hosted runner group for an enterprise.\"

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", + "descriptionHTML": "

Deletes a secret in an organization using the secret name.

\n

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", @@ -14436,14 +13914,14 @@ { "serverUrl": "https://api.github.com", "verb": "get", - "requestPath": "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners", - "title": "List self-hosted runners in a group for an enterprise", + "requestPath": "/orgs/{org}/actions/secrets/{secret_name}/repositories", + "title": "List selected repositories for an organization secret", "category": "actions", - "subcategory": "self-hosted-runner-groups", + "subcategory": "secrets", "parameters": [ { - "name": "enterprise", - "description": "

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

", + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", "in": "path", "required": true, "schema": { @@ -14451,39 +13929,43 @@ } }, { - "name": "runner_group_id", - "description": "

Unique identifier of the self-hosted runner group.

", + "name": "secret_name", + "description": "

The name of the secret.

", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" } }, { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "name": "page", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", - "default": 30 + "default": 1 } }, { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "name": "per_page", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", - "default": 1 + "default": 30 } } ], "bodyParameters": [], "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Secrets\" organization permissions": "read" + } + ] }, "codeExamples": [ { @@ -14492,8 +13974,8 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "enterprise": "ENTERPRISE", - "runner_group_id": "RUNNER_GROUP_ID" + "org": "ORG", + "secret_name": "SECRET_NAME" } }, "response": { @@ -14501,1668 +13983,8 @@ "contentType": "application/json", "description": "

Response

", "example": { - "total_count": 2, - "runners": [ - { - "id": 23, - "name": "linux_runner", - "os": "linux", - "status": "online", - "busy": true, - "ephemeral": false, - "labels": [ - { - "id": 5, - "name": "self-hosted", - "type": "read-only" - }, - { - "id": 7, - "name": "X64", - "type": "read-only" - }, - { - "id": 11, - "name": "Linux", - "type": "read-only" - } - ] - }, - { - "id": 24, - "name": "mac_runner", - "os": "macos", - "status": "offline", - "busy": false, - "ephemeral": false, - "labels": [ - { - "id": 5, - "name": "self-hosted", - "type": "read-only" - }, - { - "id": 7, - "name": "X64", - "type": "read-only" - }, - { - "id": 20, - "name": "macOS", - "type": "read-only" - }, - { - "id": 21, - "name": "no-gpu", - "type": "custom" - } - ] - } - ] - }, - "schema": { - "type": "object", - "properties": { - "total_count": { - "type": "number" - }, - "runners": { - "type": "array", - "items": { - "title": "Self hosted runners", - "description": "A self hosted runner", - "type": "object", - "properties": { - "id": { - "description": "The ID of the runner.", - "type": "integer", - "examples": [ - 5 - ] - }, - "runner_group_id": { - "description": "The ID of the runner group.", - "type": "integer", - "examples": [ - 1 - ] - }, - "name": { - "description": "The name of the runner.", - "type": "string", - "examples": [ - "iMac" - ] - }, - "os": { - "description": "The Operating System of the runner.", - "type": "string", - "examples": [ - "macos" - ] - }, - "status": { - "description": "The status of the runner.", - "type": "string", - "examples": [ - "online" - ] - }, - "busy": { - "type": "boolean" - }, - "labels": { - "type": "array", - "items": { - "title": "Self hosted runner label", - "description": "A label for a self hosted runner", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "Unique identifier of the label." - }, - "name": { - "type": "string", - "description": "Name of the label." - }, - "type": { - "type": "string", - "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", - "enum": [ - "read-only", - "custom" - ] - } - }, - "required": [ - "name" - ] - } - }, - "ephemeral": { - "type": "boolean" - } - }, - "required": [ - "id", - "name", - "os", - "status", - "busy", - "labels" - ] - } - } - }, - "required": [ - "total_count", - "runners" - ] - } - } - } - ], - "previews": [], - "descriptionHTML": "

Lists the self-hosted runners that are in a specific enterprise group.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "put", - "requestPath": "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners", - "title": "Set self-hosted runners in a group for an enterprise", - "category": "actions", - "subcategory": "self-hosted-runner-groups", - "parameters": [ - { - "name": "enterprise", - "description": "

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "runner_group_id", - "description": "

Unique identifier of the self-hosted runner group.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "array of integers", - "name": "runners", - "in": "body", - "description": "

List of runner IDs to add to the runner group.

", - "isRequired": true - } - ], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - }, - "codeExamples": [ - { - "key": "default", - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "runners": [ - 9, - 2 - ] - }, - "parameters": { - "enterprise": "ENTERPRISE", - "runner_group_id": "RUNNER_GROUP_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "previews": [], - "descriptionHTML": "

Replaces the list of self-hosted runners that are part of an enterprise runner group.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "put", - "requestPath": "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}", - "title": "Add a self-hosted runner to a group for an enterprise", - "category": "actions", - "subcategory": "self-hosted-runner-groups", - "parameters": [ - { - "name": "enterprise", - "description": "

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "runner_group_id", - "description": "

Unique identifier of the self-hosted runner group.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "runner_id", - "description": "

Unique identifier of the self-hosted runner.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - }, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "enterprise": "ENTERPRISE", - "runner_group_id": "RUNNER_GROUP_ID", - "runner_id": "RUNNER_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "previews": [], - "descriptionHTML": "

Adds a self-hosted runner to a runner group configured in an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "delete", - "requestPath": "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}", - "title": "Remove a self-hosted runner from a group for an enterprise", - "category": "actions", - "subcategory": "self-hosted-runner-groups", - "parameters": [ - { - "name": "enterprise", - "description": "

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "runner_group_id", - "description": "

Unique identifier of the self-hosted runner group.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "runner_id", - "description": "

Unique identifier of the self-hosted runner.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - }, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "enterprise": "ENTERPRISE", - "runner_group_id": "RUNNER_GROUP_ID", - "runner_id": "RUNNER_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "previews": [], - "descriptionHTML": "

Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/orgs/{org}/actions/runner-groups", - "title": "List self-hosted runner groups for an organization", - "category": "actions", - "subcategory": "self-hosted-runner-groups", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "visible_to_repository", - "description": "

Only return runner groups that are allowed to be used by this repository.

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Self-hosted runners\" organization permissions": "read" - } - ] - }, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "total_count": 3, - "runner_groups": [ - { - "id": 1, - "name": "Default", - "visibility": "all", - "default": true, - "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/1/runners", - "inherited": false, - "allows_public_repositories": true, - "restricted_to_workflows": false, - "selected_workflows": [], - "workflow_restrictions_read_only": false - }, - { - "id": 2, - "name": "octo-runner-group", - "visibility": "selected", - "default": false, - "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/repositories", - "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners", - "inherited": true, - "allows_public_repositories": true, - "restricted_to_workflows": true, - "selected_workflows": [ - "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" - ], - "workflow_restrictions_read_only": true - }, - { - "id": 3, - "name": "expensive-hardware", - "visibility": "private", - "default": false, - "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/3/runners", - "inherited": false, - "allows_public_repositories": true, - "restricted_to_workflows": false, - "selected_workflows": [ - "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" - ], - "workflow_restrictions_read_only": false - } - ] - }, - "schema": { - "type": "object", - "required": [ - "total_count", - "runner_groups" - ], - "properties": { - "total_count": { - "type": "number" - }, - "runner_groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "number" - }, - "name": { - "type": "string" - }, - "visibility": { - "type": "string" - }, - "default": { - "type": "boolean" - }, - "selected_repositories_url": { - "description": "Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected`", - "type": "string" - }, - "runners_url": { - "type": "string" - }, - "hosted_runners_url": { - "type": "string" - }, - "network_configuration_id": { - "description": "The identifier of a hosted compute network configuration.", - "type": "string" - }, - "inherited": { - "type": "boolean" - }, - "inherited_allows_public_repositories": { - "type": "boolean" - }, - "allows_public_repositories": { - "type": "boolean" - }, - "workflow_restrictions_read_only": { - "description": "If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.", - "type": "boolean", - "default": false - }, - "restricted_to_workflows": { - "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", - "type": "boolean", - "default": false - }, - "selected_workflows": { - "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", - "type": "array", - "items": { - "type": "string", - "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", - "examples": [ - "octo-org/octo-repo/.github/workflows/deploy.yaml@main" - ] - } - } - }, - "required": [ - "id", - "name", - "visibility", - "default", - "runners_url", - "inherited", - "allows_public_repositories" - ] - } - } - } - } - } - } - ], - "previews": [], - "descriptionHTML": "

Lists all self-hosted runner groups configured in an organization and inherited from an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "post", - "requestPath": "/orgs/{org}/actions/runner-groups", - "title": "Create a self-hosted runner group for an organization", - "category": "actions", - "subcategory": "self-hosted-runner-groups", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "name", - "in": "body", - "description": "

Name of the runner group.

", - "isRequired": true - }, - { - "type": "string", - "name": "visibility", - "in": "body", - "description": "

Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories.

", - "enum": [ - "selected", - "all", - "private" - ], - "default": "all" - }, - { - "type": "array of integers", - "name": "selected_repository_ids", - "in": "body", - "description": "

List of repository IDs that can access the runner group.

" - }, - { - "type": "array of integers", - "name": "runners", - "in": "body", - "description": "

List of runner IDs to add to the runner group.

" - }, - { - "type": "boolean", - "name": "allows_public_repositories", - "in": "body", - "description": "

Whether the runner group can be used by public repositories.

", - "default": false - }, - { - "type": "boolean", - "name": "restricted_to_workflows", - "in": "body", - "description": "

If true, the runner group will be restricted to running only the workflows specified in the selected_workflows array.

", - "default": false - }, - { - "type": "array of strings", - "name": "selected_workflows", - "in": "body", - "description": "

List of workflows the runner group should be allowed to run. This setting will be ignored unless restricted_to_workflows is set to true.

" - }, - { - "type": "string", - "name": "network_configuration_id", - "in": "body", - "description": "

The identifier of a hosted compute network configuration.

" - } - ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Self-hosted runners\" organization permissions": "write" - } - ] - }, - "codeExamples": [ - { - "key": "default", - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "name": "Expensive hardware runners", - "visibility": "selected", - "selected_repository_ids": [ - 32, - 91 - ], - "runners": [ - 9, - 2 - ] - }, - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 2, - "name": "octo-runner-group", - "visibility": "selected", - "default": false, - "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner-groups/2/repositories", - "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners", - "hosted_runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/hosted-runners", - "network_configuration_id": "EC486D5D793175D7E3B29C27318D5C1AAE49A7833FC85F2E82C3D2C54AC7D3BA", - "inherited": false, - "allows_public_repositories": true, - "restricted_to_workflows": true, - "selected_workflows": [ - "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" - ], - "workflow_restrictions_read_only": false - }, - "schema": { - "type": "object", - "properties": { - "id": { - "type": "number" - }, - "name": { - "type": "string" - }, - "visibility": { - "type": "string" - }, - "default": { - "type": "boolean" - }, - "selected_repositories_url": { - "description": "Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected`", - "type": "string" - }, - "runners_url": { - "type": "string" - }, - "hosted_runners_url": { - "type": "string" - }, - "network_configuration_id": { - "description": "The identifier of a hosted compute network configuration.", - "type": "string" - }, - "inherited": { - "type": "boolean" - }, - "inherited_allows_public_repositories": { - "type": "boolean" - }, - "allows_public_repositories": { - "type": "boolean" - }, - "workflow_restrictions_read_only": { - "description": "If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.", - "type": "boolean", - "default": false - }, - "restricted_to_workflows": { - "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", - "type": "boolean", - "default": false - }, - "selected_workflows": { - "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", - "type": "array", - "items": { - "type": "string", - "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", - "examples": [ - "octo-org/octo-repo/.github/workflows/deploy.yaml@main" - ] - } - } - }, - "required": [ - "id", - "name", - "visibility", - "default", - "runners_url", - "inherited", - "allows_public_repositories" - ] - } - } - } - ], - "previews": [], - "descriptionHTML": "

Creates a new self-hosted runner group for an organization.

\n

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Created

" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}", - "title": "Get a self-hosted runner group for an organization", - "category": "actions", - "subcategory": "self-hosted-runner-groups", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "runner_group_id", - "description": "

Unique identifier of the self-hosted runner group.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Self-hosted runners\" organization permissions": "read" - } - ] - }, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "runner_group_id": "RUNNER_GROUP_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 2, - "name": "octo-runner-group", - "visibility": "selected", - "default": false, - "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/repositories", - "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners", - "hosted_runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/hosted-runners", - "network_configuration_id": "EC486D5D793175D7E3B29C27318D5C1AAE49A7833FC85F2E82C3D2C54AC7D3BA", - "inherited": false, - "allows_public_repositories": true, - "restricted_to_workflows": true, - "selected_workflows": [ - "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" - ], - "workflow_restrictions_read_only": false - }, - "schema": { - "type": "object", - "properties": { - "id": { - "type": "number" - }, - "name": { - "type": "string" - }, - "visibility": { - "type": "string" - }, - "default": { - "type": "boolean" - }, - "selected_repositories_url": { - "description": "Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected`", - "type": "string" - }, - "runners_url": { - "type": "string" - }, - "hosted_runners_url": { - "type": "string" - }, - "network_configuration_id": { - "description": "The identifier of a hosted compute network configuration.", - "type": "string" - }, - "inherited": { - "type": "boolean" - }, - "inherited_allows_public_repositories": { - "type": "boolean" - }, - "allows_public_repositories": { - "type": "boolean" - }, - "workflow_restrictions_read_only": { - "description": "If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.", - "type": "boolean", - "default": false - }, - "restricted_to_workflows": { - "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", - "type": "boolean", - "default": false - }, - "selected_workflows": { - "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", - "type": "array", - "items": { - "type": "string", - "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", - "examples": [ - "octo-org/octo-repo/.github/workflows/deploy.yaml@main" - ] - } - } - }, - "required": [ - "id", - "name", - "visibility", - "default", - "runners_url", - "inherited", - "allows_public_repositories" - ] - } - } - } - ], - "previews": [], - "descriptionHTML": "

Gets a specific self-hosted runner group for an organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "patch", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}", - "title": "Update a self-hosted runner group for an organization", - "category": "actions", - "subcategory": "self-hosted-runner-groups", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "runner_group_id", - "description": "

Unique identifier of the self-hosted runner group.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "name", - "in": "body", - "description": "

Name of the runner group.

", - "isRequired": true - }, - { - "type": "string", - "name": "visibility", - "in": "body", - "description": "

Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories.

", - "enum": [ - "selected", - "all", - "private" - ] - }, - { - "type": "boolean", - "name": "allows_public_repositories", - "in": "body", - "description": "

Whether the runner group can be used by public repositories.

", - "default": false - }, - { - "type": "boolean", - "name": "restricted_to_workflows", - "in": "body", - "description": "

If true, the runner group will be restricted to running only the workflows specified in the selected_workflows array.

", - "default": false - }, - { - "type": "array of strings", - "name": "selected_workflows", - "in": "body", - "description": "

List of workflows the runner group should be allowed to run. This setting will be ignored unless restricted_to_workflows is set to true.

" - }, - { - "type": "string or null", - "name": "network_configuration_id", - "in": "body", - "description": "

The identifier of a hosted compute network configuration.

" - } - ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Self-hosted runners\" organization permissions": "write" - } - ] - }, - "codeExamples": [ - { - "key": "default", - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "name": "Expensive hardware runners", - "visibility": "selected" - }, - "parameters": { - "org": "ORG", - "runner_group_id": "RUNNER_GROUP_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 2, - "name": "octo-runner-group", - "visibility": "selected", - "default": false, - "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner-groups/2/repositories", - "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners", - "hosted_runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/hosted-runners", - "network_configuration_id": "EC486D5D793175D7E3B29C27318D5C1AAE49A7833FC85F2E82C3D2C54AC7D3BA", - "inherited": false, - "allows_public_repositories": true, - "restricted_to_workflows": true, - "selected_workflows": [ - "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" - ], - "workflow_restrictions_read_only": false - }, - "schema": { - "type": "object", - "properties": { - "id": { - "type": "number" - }, - "name": { - "type": "string" - }, - "visibility": { - "type": "string" - }, - "default": { - "type": "boolean" - }, - "selected_repositories_url": { - "description": "Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected`", - "type": "string" - }, - "runners_url": { - "type": "string" - }, - "hosted_runners_url": { - "type": "string" - }, - "network_configuration_id": { - "description": "The identifier of a hosted compute network configuration.", - "type": "string" - }, - "inherited": { - "type": "boolean" - }, - "inherited_allows_public_repositories": { - "type": "boolean" - }, - "allows_public_repositories": { - "type": "boolean" - }, - "workflow_restrictions_read_only": { - "description": "If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.", - "type": "boolean", - "default": false - }, - "restricted_to_workflows": { - "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", - "type": "boolean", - "default": false - }, - "selected_workflows": { - "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", - "type": "array", - "items": { - "type": "string", - "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", - "examples": [ - "octo-org/octo-repo/.github/workflows/deploy.yaml@main" - ] - } - } - }, - "required": [ - "id", - "name", - "visibility", - "default", - "runners_url", - "inherited", - "allows_public_repositories" - ] - } - } - } - ], - "previews": [], - "descriptionHTML": "

Updates the name and visibility of a self-hosted runner group in an organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}", - "title": "Delete a self-hosted runner group from an organization", - "category": "actions", - "subcategory": "self-hosted-runner-groups", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "runner_group_id", - "description": "

Unique identifier of the self-hosted runner group.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Self-hosted runners\" organization permissions": "write" - } - ] - }, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "runner_group_id": "RUNNER_GROUP_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "previews": [], - "descriptionHTML": "

Deletes a self-hosted runner group for an organization.

\n

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/hosted-runners", - "title": "List GitHub-hosted runners in a group for an organization", - "category": "actions", - "subcategory": "self-hosted-runner-groups", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "runner_group_id", - "description": "

Unique identifier of the self-hosted runner group.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Self-hosted runners\" organization permissions": "read" - } - ] - }, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "runner_group_id": "RUNNER_GROUP_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "total_count": 2, - "runners": [ - { - "id": 5, - "name": "My hosted ubuntu runner", - "runner_group_id": 2, - "platform": "linux-x64", - "image": { - "id": "ubuntu-20.04", - "size": 86 - }, - "machine_size_details": { - "id": "4-core", - "cpu_cores": 4, - "memory_gb": 16, - "storage_gb": 150 - }, - "status": "Ready", - "maximum_runners": 10, - "public_ip_enabled": true, - "public_ips": [ - { - "enabled": true, - "prefix": "20.80.208.150", - "length": 31 - } - ], - "last_active_on": "2022-10-09T23:39:01Z" - }, - { - "id": 7, - "name": "My hosted Windows runner", - "runner_group_id": 2, - "platform": "win-x64", - "image": { - "id": "windows-latest", - "size": 256 - }, - "machine_size_details": { - "id": "8-core", - "cpu_cores": 8, - "memory_gb": 32, - "storage_gb": 300 - }, - "status": "Ready", - "maximum_runners": 20, - "public_ip_enabled": false, - "public_ips": [], - "last_active_on": "2023-04-26T15:23:37Z" - } - ] - }, - "schema": { - "type": "object", - "required": [ - "total_count", - "runners" - ], - "properties": { - "total_count": { - "type": "number" - }, - "runners": { - "type": "array", - "items": { - "title": "GitHub-hosted hosted runner", - "description": "A Github-hosted hosted runner.", - "type": "object", - "properties": { - "id": { - "description": "The unique identifier of the hosted runner.", - "type": "integer", - "examples": [ - 5 - ] - }, - "name": { - "description": "The name of the hosted runner.", - "type": "string", - "examples": [ - "my-github-hosted-runner" - ] - }, - "runner_group_id": { - "description": "The unique identifier of the group that the hosted runner belongs to.", - "type": "integer", - "examples": [ - 2 - ] - }, - "image_details": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "GitHub-hosted runner image details.", - "description": "Provides details of a hosted runner image", - "type": "object", - "properties": { - "id": { - "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", - "type": "string", - "examples": [ - "ubuntu-20.04" - ] - }, - "size_gb": { - "description": "Image size in GB.", - "type": "integer", - "examples": [ - 86 - ] - }, - "display_name": { - "description": "Display name for this image.", - "type": "string", - "examples": [ - 20.04 - ] - }, - "source": { - "description": "The image provider.", - "type": "string", - "enum": [ - "github", - "partner", - "custom" - ] - } - }, - "required": [ - "id", - "size_gb", - "display_name", - "source" - ] - } - ] - }, - "machine_size_details": { - "title": "Github-owned VM details.", - "description": "Provides details of a particular machine spec.", - "type": "object", - "properties": { - "id": { - "description": "The ID used for the `size` parameter when creating a new runner.", - "type": "string", - "examples": [ - "8-core" - ] - }, - "cpu_cores": { - "description": "The number of cores.", - "type": "integer", - "examples": [ - 8 - ] - }, - "memory_gb": { - "description": "The available RAM for the machine spec.", - "type": "integer", - "examples": [ - 32 - ] - }, - "storage_gb": { - "description": "The available SSD storage for the machine spec.", - "type": "integer", - "examples": [ - 300 - ] - } - }, - "required": [ - "id", - "cpu_cores", - "memory_gb", - "storage_gb" - ] - }, - "status": { - "description": "The status of the runner.", - "type": "string", - "enum": [ - "Ready", - "Provisioning", - "Shutdown", - "Deleting", - "Stuck" - ], - "examples": [ - "Ready" - ] - }, - "platform": { - "description": "The operating system of the image.", - "type": "string", - "examples": [ - "linux-x64" - ] - }, - "maximum_runners": { - "description": "The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost.", - "type": "integer", - "default": 10, - "examples": [ - 5 - ] - }, - "public_ip_enabled": { - "description": "Whether public IP is enabled for the hosted runners.", - "type": "boolean", - "examples": [ - true - ] - }, - "public_ips": { - "description": "The public IP ranges when public IP is enabled for the hosted runners.", - "type": "array", - "items": { - "title": "Public IP for a GitHub-hosted larger runners.", - "description": "Provides details of Public IP for a GitHub-hosted larger runners", - "type": "object", - "properties": { - "enabled": { - "description": "Whether public IP is enabled.", - "type": "boolean", - "examples": [ - true - ] - }, - "prefix": { - "description": "The prefix for the public IP.", - "type": "string", - "examples": [ - "20.80.208.150" - ] - }, - "length": { - "description": "The length of the IP prefix.", - "type": "integer", - "examples": [ - 28 - ] - } - } - } - }, - "last_active_on": { - "description": "The time at which the runner was last used, in ISO 8601 format.", - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2022-10-09T23:39:01Z" - ] - } - }, - "required": [ - "id", - "name", - "image_details", - "machine_size_details", - "status", - "public_ip_enabled", - "platform" - ] - } - } - } - } - } - } - ], - "previews": [], - "descriptionHTML": "

Lists the GitHub-hosted runners in an organization group.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories", - "title": "List repository access to a self-hosted runner group in an organization", - "category": "actions", - "subcategory": "self-hosted-runner-groups", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "runner_group_id", - "description": "

Unique identifier of the self-hosted runner group.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - } - ], - "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Self-hosted runners\" organization permissions": "read" - } - ] - }, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "runner_group_id": "RUNNER_GROUP_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "total_count": 1, - "repositories": [ + "total_count": 1, + "repositories": [ { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", @@ -16230,179 +14052,7 @@ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World.git", - "mirror_url": "git:git.example.com/octocat/Hello-World", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World", - "homepage": "https://github.com", - "language": null, - "forks_count": 9, - "stargazers_count": 80, - "watchers_count": 80, - "size": 108, - "default_branch": "master", - "open_issues_count": 0, - "is_template": true, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "archived": false, - "disabled": false, - "visibility": "public", - "pushed_at": "2011-01-26T19:06:43Z", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "permissions": { - "admin": false, - "push": false, - "pull": true - }, - "template_repository": { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "owner": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World", - "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World.git", - "mirror_url": "git:git.example.com/octocat/Hello-World", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World", - "homepage": "https://github.com", - "organization": null, - "language": null, - "forks": 9, - "forks_count": 9, - "stargazers_count": 80, - "watchers_count": 80, - "watchers": 80, - "size": 108, - "default_branch": "master", - "open_issues": 0, - "open_issues_count": 0, - "is_template": true, - "license": { - "key": "mit", - "name": "MIT License", - "url": "https://api.github.com/licenses/mit", - "spdx_id": "MIT", - "node_id": "MDc6TGljZW5zZW1pdA==", - "html_url": "https://api.github.com/licenses/mit" - }, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "archived": false, - "disabled": false, - "visibility": "public", - "pushed_at": "2011-01-26T19:06:43Z", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "permissions": { - "admin": false, - "push": false, - "pull": true - }, - "allow_rebase_merge": true, - "template_repository": null, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "allow_squash_merge": true, - "allow_auto_merge": false, - "delete_branch_on_merge": true, - "allow_merge_commit": true, - "subscribers_count": 42, - "network_count": 0 - }, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "delete_branch_on_merge": true, - "subscribers_count": 42, - "network_count": 0, - "license": { - "key": "mit", - "name": "MIT License", - "url": "https://api.github.com/licenses/mit", - "spdx_id": "MIT", - "node_id": "MDc6TGljZW5zZW1pdA==" - }, - "forks": 1, - "open_issues": 1, - "watchers": 1 + "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" } ] }, @@ -16414,7 +14064,7 @@ ], "properties": { "total_count": { - "type": "number" + "type": "integer" }, "repositories": { "type": "array", @@ -17291,21 +14941,21 @@ } ], "previews": [], - "descriptionHTML": "

Lists the repositories with access to a self-hosted runner group configured in an organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Lists all repositories that have been selected when the visibility\nfor repository access to a secret is set to selected.

\n

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

" }, { "serverUrl": "https://api.github.com", "verb": "put", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories", - "title": "Set repository access for a self-hosted runner group in an organization", + "requestPath": "/orgs/{org}/actions/secrets/{secret_name}/repositories", + "title": "Set selected repositories for an organization secret", "category": "actions", - "subcategory": "self-hosted-runner-groups", + "subcategory": "secrets", "parameters": [ { "name": "org", @@ -17317,12 +14967,12 @@ } }, { - "name": "runner_group_id", - "description": "

Unique identifier of the self-hosted runner group.

", + "name": "secret_name", + "description": "

The name of the secret.

", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" } } ], @@ -17331,7 +14981,7 @@ "type": "array of integers", "name": "selected_repository_ids", "in": "body", - "description": "

List of repository IDs that can access the runner group.

", + "description": "

An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can add and remove individual repositories using the Add selected repository to an organization secret and Remove selected repository from an organization secret endpoints.

", "isRequired": true } ], @@ -17341,7 +14991,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Self-hosted runners\" organization permissions": "write" + "\"Secrets\" organization permissions": "write" } ] }, @@ -17354,13 +15004,12 @@ "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "selected_repository_ids": [ - 32, - 91 + 64780797 ] }, "parameters": { "org": "ORG", - "runner_group_id": "RUNNER_GROUP_ID" + "secret_name": "SECRET_NAME" } }, "response": { @@ -17370,7 +15019,7 @@ } ], "previews": [], - "descriptionHTML": "

Replaces the list of repositories that have access to a self-hosted runner group configured in an organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", + "descriptionHTML": "

Replaces all repositories for an organization secret when the visibility\nfor repository access is set to selected. The visibility is set when you Create\nor update an organization secret.

\n

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

", "statusCodes": [ { "httpStatusCode": "204", @@ -17381,10 +15030,10 @@ { "serverUrl": "https://api.github.com", "verb": "put", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}", - "title": "Add repository access to a self-hosted runner group in an organization", + "requestPath": "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}", + "title": "Add selected repository to an organization secret", "category": "actions", - "subcategory": "self-hosted-runner-groups", + "subcategory": "secrets", "parameters": [ { "name": "org", @@ -17396,22 +15045,22 @@ } }, { - "name": "runner_group_id", - "description": "

Unique identifier of the self-hosted runner group.

", + "name": "secret_name", + "description": "

The name of the secret.

", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" } }, { "name": "repository_id", - "description": "

The unique identifier of the repository.

", "in": "path", "required": true, "schema": { "type": "integer" - } + }, + "description": "" } ], "bodyParameters": [], @@ -17421,7 +15070,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Self-hosted runners\" organization permissions": "write", + "\"Secrets\" organization permissions": "write", "\"Metadata\" repository permissions": "read" } ] @@ -17434,32 +15083,36 @@ "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", - "runner_group_id": "RUNNER_GROUP_ID", + "secret_name": "SECRET_NAME", "repository_id": "REPOSITORY_ID" } }, "response": { "statusCode": "204", - "description": "

Response

" + "description": "

No Content when repository was added to the selected list

" } } ], "previews": [], - "descriptionHTML": "

Adds a repository to the list of repositories that can access a self-hosted runner group. The runner group must have visibility set to selected. For more information, see \"Create a self-hosted runner group for an organization.\"

\n

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", + "descriptionHTML": "

Adds a repository to an organization secret when the visibility for\nrepository access is set to selected. For more information about setting the visibility, see Create or\nupdate an organization secret.

\n

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", - "description": "

No Content

" + "description": "

No Content when repository was added to the selected list

" + }, + { + "httpStatusCode": "409", + "description": "

Conflict when visibility type is not set to selected

" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}", - "title": "Remove repository access to a self-hosted runner group in an organization", + "requestPath": "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}", + "title": "Remove selected repository from an organization secret", "category": "actions", - "subcategory": "self-hosted-runner-groups", + "subcategory": "secrets", "parameters": [ { "name": "org", @@ -17471,22 +15124,22 @@ } }, { - "name": "runner_group_id", - "description": "

Unique identifier of the self-hosted runner group.

", + "name": "secret_name", + "description": "

The name of the secret.

", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" } }, { "name": "repository_id", - "description": "

The unique identifier of the repository.

", "in": "path", "required": true, "schema": { "type": "integer" - } + }, + "description": "" } ], "bodyParameters": [], @@ -17496,7 +15149,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Self-hosted runners\" organization permissions": "write", + "\"Secrets\" organization permissions": "write", "\"Metadata\" repository permissions": "read" } ] @@ -17509,36 +15162,40 @@ "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", - "runner_group_id": "RUNNER_GROUP_ID", + "secret_name": "SECRET_NAME", "repository_id": "REPOSITORY_ID" } }, "response": { "statusCode": "204", - "description": "

Response

" + "description": "

Response when repository was removed from the selected list

" } } ], "previews": [], - "descriptionHTML": "

Removes a repository from the list of selected repositories that can access a self-hosted runner group. The runner group must have visibility set to selected. For more information, see \"Create a self-hosted runner group for an organization.\"

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", + "descriptionHTML": "

Removes a repository from an organization secret when the visibility\nfor repository access is set to selected. The visibility is set when you Create\nor update an organization secret.

\n

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

", "statusCodes": [ { "httpStatusCode": "204", - "description": "

No Content

" + "description": "

Response when repository was removed from the selected list

" + }, + { + "httpStatusCode": "409", + "description": "

Conflict when visibility type not set to selected

" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners", - "title": "List self-hosted runners in a group for an organization", + "requestPath": "/repos/{owner}/{repo}/actions/organization-secrets", + "title": "List repository organization secrets", "category": "actions", - "subcategory": "self-hosted-runner-groups", + "subcategory": "secrets", "parameters": [ { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", "in": "path", "required": true, "schema": { @@ -17546,12 +15203,12 @@ } }, { - "name": "runner_group_id", - "description": "

Unique identifier of the self-hosted runner group.

", + "name": "repo", + "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" } }, { @@ -17580,7 +15237,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Self-hosted runners\" organization permissions": "read" + "\"Secrets\" repository permissions": "read" } ] }, @@ -17591,8 +15248,8 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "org": "ORG", - "runner_group_id": "RUNNER_GROUP_ID" + "owner": "OWNER", + "repo": "REPO" } }, "response": { @@ -17601,61 +15258,16 @@ "description": "

Response

", "example": { "total_count": 2, - "runners": [ + "secrets": [ { - "id": 23, - "name": "linux_runner", - "os": "linux", - "status": "online", - "busy": true, - "ephemeral": false, - "labels": [ - { - "id": 5, - "name": "self-hosted", - "type": "read-only" - }, - { - "id": 7, - "name": "X64", - "type": "read-only" - }, - { - "id": 11, - "name": "Linux", - "type": "read-only" - } - ] + "name": "GH_TOKEN", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z" }, { - "id": 24, - "name": "mac_runner", - "os": "macos", - "status": "offline", - "busy": false, - "ephemeral": false, - "labels": [ - { - "id": 5, - "name": "self-hosted", - "type": "read-only" - }, - { - "id": 7, - "name": "X64", - "type": "read-only" - }, - { - "id": 20, - "name": "macOS", - "type": "read-only" - }, - { - "id": 21, - "name": "no-gpu", - "type": "custom" - } - ] + "name": "GIST_ID", + "created_at": "2020-01-10T10:59:22Z", + "updated_at": "2020-01-11T11:59:22Z" } ] }, @@ -17663,97 +15275,39 @@ "type": "object", "required": [ "total_count", - "runners" + "secrets" ], "properties": { "total_count": { - "type": "number" + "type": "integer" }, - "runners": { + "secrets": { "type": "array", "items": { - "title": "Self hosted runners", - "description": "A self hosted runner", + "title": "Actions Secret", + "description": "Set secrets for GitHub Actions.", "type": "object", "properties": { - "id": { - "description": "The ID of the runner.", - "type": "integer", - "examples": [ - 5 - ] - }, - "runner_group_id": { - "description": "The ID of the runner group.", - "type": "integer", - "examples": [ - 1 - ] - }, "name": { - "description": "The name of the runner.", + "description": "The name of the secret.", "type": "string", "examples": [ - "iMac" + "SECRET_TOKEN" ] }, - "os": { - "description": "The Operating System of the runner.", + "created_at": { "type": "string", - "examples": [ - "macos" - ] + "format": "date-time" }, - "status": { - "description": "The status of the runner.", + "updated_at": { "type": "string", - "examples": [ - "online" - ] - }, - "busy": { - "type": "boolean" - }, - "labels": { - "type": "array", - "items": { - "title": "Self hosted runner label", - "description": "A label for a self hosted runner", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "Unique identifier of the label." - }, - "name": { - "type": "string", - "description": "Name of the label." - }, - "type": { - "type": "string", - "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", - "enum": [ - "read-only", - "custom" - ] - } - }, - "required": [ - "name" - ] - } - }, - "ephemeral": { - "type": "boolean" + "format": "date-time" } }, "required": [ - "id", "name", - "os", - "status", - "busy", - "labels" + "created_at", + "updated_at" ] } } @@ -17763,7 +15317,7 @@ } ], "previews": [], - "descriptionHTML": "

Lists self-hosted runners that are in a specific organization group.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", + "descriptionHTML": "

Lists all organization secrets shared with a repository without revealing their encrypted\nvalues.

\n

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -17773,15 +15327,15 @@ }, { "serverUrl": "https://api.github.com", - "verb": "put", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners", - "title": "Set self-hosted runners in a group for an organization", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/actions/secrets", + "title": "List repository secrets", "category": "actions", - "subcategory": "self-hosted-runner-groups", + "subcategory": "secrets", "parameters": [ { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", "in": "path", "required": true, "schema": { @@ -17789,21 +15343,402 @@ } }, { - "name": "runner_group_id", - "description": "

Unique identifier of the self-hosted runner group.

", + "name": "repo", + "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" + } + }, + { + "name": "per_page", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Secrets\" repository permissions": "read" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "total_count": 2, + "secrets": [ + { + "name": "GH_TOKEN", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z" + }, + { + "name": "GIST_ID", + "created_at": "2020-01-10T10:59:22Z", + "updated_at": "2020-01-11T11:59:22Z" + } + ] + }, + "schema": { + "type": "object", + "required": [ + "total_count", + "secrets" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "secrets": { + "type": "array", + "items": { + "title": "Actions Secret", + "description": "Set secrets for GitHub Actions.", + "type": "object", + "properties": { + "name": { + "description": "The name of the secret.", + "type": "string", + "examples": [ + "SECRET_TOKEN" + ] + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "name", + "created_at", + "updated_at" + ] + } + } + } + } + } + } + ], + "previews": [], + "descriptionHTML": "

Lists all secrets available in a repository without revealing their encrypted\nvalues.

\n

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/actions/secrets/public-key", + "title": "Get a repository public key", + "category": "actions", + "subcategory": "secrets", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Secrets\" repository permissions": "read" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "key_id": "012345678912345678", + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" + }, + "schema": { + "title": "ActionsPublicKey", + "description": "The public key used for setting Actions Secrets.", + "type": "object", + "properties": { + "key_id": { + "description": "The identifier for the key.", + "type": "string", + "examples": [ + "1234567" + ] + }, + "key": { + "description": "The Base64 encoded public key.", + "type": "string", + "examples": [ + "hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=" + ] + }, + "id": { + "type": "integer", + "examples": [ + 2 + ] + }, + "url": { + "type": "string", + "examples": [ + "https://api.github.com/user/keys/2" + ] + }, + "title": { + "type": "string", + "examples": [ + "ssh-rsa AAAAB3NzaC1yc2EAAA" + ] + }, + "created_at": { + "type": "string", + "examples": [ + "2011-01-26T19:01:12Z" + ] + } + }, + "required": [ + "key_id", + "key" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "

Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.

\n

Anyone with read access to the repository can use this endpoint.

\n

If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/actions/secrets/{secret_name}", + "title": "Get a repository secret", + "category": "actions", + "subcategory": "secrets", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "secret_name", + "description": "

The name of the secret.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Secrets\" repository permissions": "read" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "secret_name": "SECRET_NAME" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "name": "GH_TOKEN", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z" + }, + "schema": { + "title": "Actions Secret", + "description": "Set secrets for GitHub Actions.", + "type": "object", + "properties": { + "name": { + "description": "The name of the secret.", + "type": "string", + "examples": [ + "SECRET_TOKEN" + ] + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "name", + "created_at", + "updated_at" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "

Gets a single repository secret without revealing its encrypted value.

\n

The authenticated user must have collaborator access to the repository to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/repos/{owner}/{repo}/actions/secrets/{secret_name}", + "title": "Create or update a repository secret", + "category": "actions", + "subcategory": "secrets", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "secret_name", + "description": "

The name of the secret.

", + "in": "path", + "required": true, + "schema": { + "type": "string" } } ], "bodyParameters": [ { - "type": "array of integers", - "name": "runners", + "type": "string", + "name": "encrypted_value", "in": "body", - "description": "

List of runner IDs to add to the runner group.

", + "description": "

Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint.

", + "isRequired": true + }, + { + "type": "string", + "name": "key_id", + "in": "body", + "description": "

ID of the key you used to encrypt the secret.

", "isRequired": true } ], @@ -17813,7 +15748,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Self-hosted runners\" organization permissions": "write" + "\"Secrets\" repository permissions": "write" } ] }, @@ -17822,45 +15757,78 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example 1: Status Code 201", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "runners": [ - 9, - 2 - ] + "encrypted_value": "c2VjcmV0", + "key_id": "012345678912345678" }, "parameters": { - "org": "ORG", - "runner_group_id": "RUNNER_GROUP_ID" + "owner": "OWNER", + "repo": "REPO", + "secret_name": "SECRET_NAME" + } + }, + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "

Response when creating a secret

", + "example": null, + "schema": { + "title": "Empty Object", + "description": "An object without any properties.", + "type": "object", + "properties": {}, + "additionalProperties": false + } + } + }, + { + "key": "204", + "request": { + "contentType": "application/json", + "description": "Example 2: Status Code 204", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "encrypted_value": "c2VjcmV0", + "key_id": "012345678912345678" + }, + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "secret_name": "SECRET_NAME" } }, "response": { "statusCode": "204", - "description": "

Response

" + "description": "

Response when updating a secret

" } } ], "previews": [], - "descriptionHTML": "

Replaces the list of self-hosted runners that are part of an organization runner group.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", + "descriptionHTML": "

Creates or updates a repository secret with an encrypted value. Encrypt your secret using\nLibSodium. For more information, see \"Encrypting secrets for the REST API.\"

\n

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ + { + "httpStatusCode": "201", + "description": "

Response when creating a secret

" + }, { "httpStatusCode": "204", - "description": "

No Content

" + "description": "

Response when updating a secret

" } ] }, { "serverUrl": "https://api.github.com", - "verb": "put", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}", - "title": "Add a self-hosted runner to a group for an organization", + "verb": "delete", + "requestPath": "/repos/{owner}/{repo}/actions/secrets/{secret_name}", + "title": "Delete a repository secret", "category": "actions", - "subcategory": "self-hosted-runner-groups", + "subcategory": "secrets", "parameters": [ { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", "in": "path", "required": true, "schema": { @@ -17868,21 +15836,21 @@ } }, { - "name": "runner_group_id", - "description": "

Unique identifier of the self-hosted runner group.

", + "name": "repo", + "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" } }, { - "name": "runner_id", - "description": "

Unique identifier of the self-hosted runner.

", + "name": "secret_name", + "description": "

The name of the secret.

", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" } } ], @@ -17893,7 +15861,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Self-hosted runners\" organization permissions": "write" + "\"Secrets\" repository permissions": "write" } ] }, @@ -17904,9 +15872,9 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "org": "ORG", - "runner_group_id": "RUNNER_GROUP_ID", - "runner_id": "RUNNER_ID" + "owner": "OWNER", + "repo": "REPO", + "secret_name": "SECRET_NAME" } }, "response": { @@ -17916,7 +15884,7 @@ } ], "previews": [], - "descriptionHTML": "

Adds a self-hosted runner to a runner group configured in an organization.

\n

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", + "descriptionHTML": "

Deletes a secret in a repository using the secret name.

\n

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", @@ -17926,15 +15894,15 @@ }, { "serverUrl": "https://api.github.com", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}", - "title": "Remove a self-hosted runner from a group for an organization", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/secrets", + "title": "List environment secrets", "category": "actions", - "subcategory": "self-hosted-runner-groups", + "subcategory": "secrets", "parameters": [ { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", "in": "path", "required": true, "schema": { @@ -17942,21 +15910,39 @@ } }, { - "name": "runner_group_id", - "description": "

Unique identifier of the self-hosted runner group.

", + "name": "repo", + "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" } }, { - "name": "runner_id", - "description": "

Unique identifier of the self-hosted runner.

", + "name": "environment_name", "in": "path", "required": true, + "description": "

The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F.

", "schema": { - "type": "integer" + "type": "string" + } + }, + { + "name": "per_page", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "in": "query", + "schema": { + "type": "integer", + "default": 1 } } ], @@ -17967,7 +15953,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Self-hosted runners\" organization permissions": "write" + "\"Environments\" repository permissions": "read" } ] }, @@ -17978,44 +15964,562 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "org": "ORG", - "runner_group_id": "RUNNER_GROUP_ID", - "runner_id": "RUNNER_ID" + "owner": "OWNER", + "repo": "REPO", + "environment_name": "ENVIRONMENT_NAME" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "total_count": 2, + "secrets": [ + { + "name": "GH_TOKEN", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z" + }, + { + "name": "GIST_ID", + "created_at": "2020-01-10T10:59:22Z", + "updated_at": "2020-01-11T11:59:22Z" + } + ] + }, + "schema": { + "type": "object", + "required": [ + "total_count", + "secrets" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "secrets": { + "type": "array", + "items": { + "title": "Actions Secret", + "description": "Set secrets for GitHub Actions.", + "type": "object", + "properties": { + "name": { + "description": "The name of the secret.", + "type": "string", + "examples": [ + "SECRET_TOKEN" + ] + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "name", + "created_at", + "updated_at" + ] + } + } + } + } + } + } + ], + "previews": [], + "descriptionHTML": "

Lists all secrets available in an environment without revealing their\nencrypted values.

\n

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/secrets/public-key", + "title": "Get an environment public key", + "category": "actions", + "subcategory": "secrets", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "environment_name", + "in": "path", + "required": true, + "description": "

The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F.

", + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Environments\" repository permissions": "read" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "environment_name": "ENVIRONMENT_NAME" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "key_id": "012345678912345678", + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" + }, + "schema": { + "title": "ActionsPublicKey", + "description": "The public key used for setting Actions Secrets.", + "type": "object", + "properties": { + "key_id": { + "description": "The identifier for the key.", + "type": "string", + "examples": [ + "1234567" + ] + }, + "key": { + "description": "The Base64 encoded public key.", + "type": "string", + "examples": [ + "hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=" + ] + }, + "id": { + "type": "integer", + "examples": [ + 2 + ] + }, + "url": { + "type": "string", + "examples": [ + "https://api.github.com/user/keys/2" + ] + }, + "title": { + "type": "string", + "examples": [ + "ssh-rsa AAAAB3NzaC1yc2EAAA" + ] + }, + "created_at": { + "type": "string", + "examples": [ + "2011-01-26T19:01:12Z" + ] + } + }, + "required": [ + "key_id", + "key" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "

Get the public key for an environment, which you need to encrypt environment\nsecrets. You need to encrypt a secret before you can create or update secrets.

\n

Anyone with read access to the repository can use this endpoint.

\n

If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}", + "title": "Get an environment secret", + "category": "actions", + "subcategory": "secrets", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "environment_name", + "in": "path", + "required": true, + "description": "

The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F.

", + "schema": { + "type": "string" + } + }, + { + "name": "secret_name", + "description": "

The name of the secret.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Environments\" repository permissions": "read" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "environment_name": "ENVIRONMENT_NAME", + "secret_name": "SECRET_NAME" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "name": "GH_TOKEN", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z" + }, + "schema": { + "title": "Actions Secret", + "description": "Set secrets for GitHub Actions.", + "type": "object", + "properties": { + "name": { + "description": "The name of the secret.", + "type": "string", + "examples": [ + "SECRET_TOKEN" + ] + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "name", + "created_at", + "updated_at" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "

Gets a single environment secret without revealing its encrypted value.

\n

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}", + "title": "Create or update an environment secret", + "category": "actions", + "subcategory": "secrets", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "environment_name", + "in": "path", + "required": true, + "description": "

The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F.

", + "schema": { + "type": "string" + } + }, + { + "name": "secret_name", + "description": "

The name of the secret.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "encrypted_value", + "in": "body", + "description": "

Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an environment public key endpoint.

", + "isRequired": true + }, + { + "type": "string", + "name": "key_id", + "in": "body", + "description": "

ID of the key you used to encrypt the secret.

", + "isRequired": true + } + ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Environments\" repository permissions": "write" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example 1: Status Code 201", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "encrypted_value": "c2VjcmV0", + "key_id": "012345678912345678" + }, + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "environment_name": "ENVIRONMENT_NAME", + "secret_name": "SECRET_NAME" + } + }, + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "

Response when creating a secret

", + "example": null, + "schema": { + "title": "Empty Object", + "description": "An object without any properties.", + "type": "object", + "properties": {}, + "additionalProperties": false + } + } + }, + { + "key": "204", + "request": { + "contentType": "application/json", + "description": "Example 2: Status Code 204", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "encrypted_value": "c2VjcmV0", + "key_id": "012345678912345678" + }, + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "environment_name": "ENVIRONMENT_NAME", + "secret_name": "SECRET_NAME" } }, "response": { "statusCode": "204", - "description": "

Response

" + "description": "

Response when updating a secret

" } } ], "previews": [], - "descriptionHTML": "

Removes a self-hosted runner from a group configured in an organization. The runner is then returned to the default group.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", + "descriptionHTML": "

Creates or updates an environment secret with an encrypted value. Encrypt your secret using\nLibSodium. For more information, see \"Encrypting secrets for the REST API.\"

\n

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ + { + "httpStatusCode": "201", + "description": "

Response when creating a secret

" + }, { "httpStatusCode": "204", - "description": "

No Content

" + "description": "

Response when updating a secret

" } ] - } - ], - "self-hosted-runners": [ + }, { "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/enterprises/{enterprise}/actions/runners", - "title": "List self-hosted runners for an enterprise", + "verb": "delete", + "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}", + "title": "Delete an environment secret", "category": "actions", - "subcategory": "self-hosted-runners", + "subcategory": "secrets", "parameters": [ { - "name": "name", - "description": "

The name of a self-hosted runner.

", - "in": "query", + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "environment_name", + "in": "path", + "required": true, + "description": "

The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F.

", "schema": { "type": "string" } }, + { + "name": "secret_name", + "description": "

The name of the secret.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Environments\" repository permissions": "write" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "environment_name": "ENVIRONMENT_NAME", + "secret_name": "SECRET_NAME" + } + }, + "response": { + "statusCode": "204", + "description": "

Default response

" + } + } + ], + "previews": [], + "descriptionHTML": "

Deletes a secret in an environment using the secret name.

\n

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "

Default response

" + } + ] + } + ], + "self-hosted-runner-groups": [ + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/enterprises/{enterprise}/actions/runner-groups", + "title": "List self-hosted runner groups for an enterprise", + "category": "actions", + "subcategory": "self-hosted-runner-groups", + "parameters": [ { "name": "enterprise", "description": "

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

", @@ -18042,6 +16546,15 @@ "type": "integer", "default": 1 } + }, + { + "name": "visible_to_organization", + "description": "

Only return runner groups that are allowed to be used by this organization.

", + "in": "query", + "required": false, + "schema": { + "type": "string" + } } ], "bodyParameters": [], @@ -18066,62 +16579,45 @@ "contentType": "application/json", "description": "

Response

", "example": { - "total_count": 2, - "runners": [ + "total_count": 3, + "runner_groups": [ { - "id": 23, - "name": "linux_runner", - "os": "linux", - "status": "online", - "busy": true, - "ephemeral": false, - "labels": [ - { - "id": 5, - "name": "self-hosted", - "type": "read-only" - }, - { - "id": 7, - "name": "X64", - "type": "read-only" - }, - { - "id": 11, - "name": "Linux", - "type": "read-only" - } - ] + "id": 1, + "name": "Default", + "visibility": "all", + "default": true, + "runners_url": "https://api.github.com/enterprises/octo-corp/actions/runner_groups/1/runners", + "allows_public_repositories": false, + "restricted_to_workflows": false, + "selected_workflows": [], + "workflow_restrictions_read_only": false }, { - "id": 24, - "name": "mac_runner", - "os": "macos", - "status": "offline", - "busy": false, - "ephemeral": false, - "labels": [ - { - "id": 5, - "name": "self-hosted", - "type": "read-only" - }, - { - "id": 7, - "name": "X64", - "type": "read-only" - }, - { - "id": 20, - "name": "macOS", - "type": "read-only" - }, - { - "id": 21, - "name": "no-gpu", - "type": "custom" - } - ] + "id": 2, + "name": "octo-runner-group", + "visibility": "selected", + "default": false, + "selected_organizations_url": "https://api.github.com/enterprises/octo-corp/actions/runner_groups/2/organizations", + "runners_url": "https://api.github.com/enterprises/octo-corp/actions/runner_groups/2/runners", + "allows_public_repositories": true, + "restricted_to_workflows": true, + "selected_workflows": [ + "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" + ], + "workflow_restrictions_read_only": false + }, + { + "id": 3, + "name": "expensive-hardware", + "visibility": "private", + "default": false, + "runners_url": "https://api.github.com/enterprises/octo-corp/actions/runner_groups/3/runners", + "allows_public_repositories": true, + "restricted_to_workflows": false, + "selected_workflows": [ + "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" + ], + "workflow_restrictions_read_only": false } ] }, @@ -18131,101 +16627,82 @@ "total_count": { "type": "number" }, - "runners": { + "runner_groups": { "type": "array", "items": { - "title": "Self hosted runners", - "description": "A self hosted runner", "type": "object", "properties": { "id": { - "description": "The ID of the runner.", - "type": "integer", - "examples": [ - 5 - ] - }, - "runner_group_id": { - "description": "The ID of the runner group.", - "type": "integer", - "examples": [ - 1 - ] + "type": "number" }, "name": { - "description": "The name of the runner.", - "type": "string", - "examples": [ - "iMac" - ] + "type": "string" }, - "os": { - "description": "The Operating System of the runner.", - "type": "string", - "examples": [ - "macos" - ] + "visibility": { + "type": "string" }, - "status": { - "description": "The status of the runner.", - "type": "string", - "examples": [ - "online" - ] + "default": { + "type": "boolean" }, - "busy": { + "selected_organizations_url": { + "type": "string" + }, + "runners_url": { + "type": "string" + }, + "hosted_runners_url": { + "type": "string" + }, + "network_configuration_id": { + "description": "The identifier of a hosted compute network configuration.", + "type": "string" + }, + "allows_public_repositories": { "type": "boolean" }, - "labels": { + "workflow_restrictions_read_only": { + "description": "If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.", + "type": "boolean", + "default": false + }, + "restricted_to_workflows": { + "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", + "type": "boolean", + "default": false + }, + "selected_workflows": { + "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", "type": "array", "items": { - "title": "Self hosted runner label", - "description": "A label for a self hosted runner", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "Unique identifier of the label." - }, - "name": { - "type": "string", - "description": "Name of the label." - }, - "type": { - "type": "string", - "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", - "enum": [ - "read-only", - "custom" - ] - } - }, - "required": [ - "name" + "type": "string", + "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", + "examples": [ + "octo-org/octo-repo/.github/workflows/deploy.yaml@main" ] } - }, - "ephemeral": { - "type": "boolean" } }, "required": [ "id", "name", - "os", - "status", - "busy", - "labels" + "visibility", + "allows_public_repositories", + "default", + "runners_url" ] } } - } + }, + "required": [ + "total_count", + "runner_groups" + ] } } } ], "previews": [], - "descriptionHTML": "

Lists all self-hosted runners configured for an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", + "descriptionHTML": "

Lists all self-hosted runner groups for an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -18233,13 +16710,211 @@ } ] }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/enterprises/{enterprise}/actions/runner-groups", + "title": "Create a self-hosted runner group for an enterprise", + "category": "actions", + "subcategory": "self-hosted-runner-groups", + "parameters": [ + { + "name": "enterprise", + "description": "

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "name", + "in": "body", + "description": "

Name of the runner group.

", + "isRequired": true + }, + { + "type": "string", + "name": "visibility", + "in": "body", + "description": "

Visibility of a runner group. You can select all organizations or select individual organization.

", + "enum": [ + "selected", + "all" + ] + }, + { + "type": "array of integers", + "name": "selected_organization_ids", + "in": "body", + "description": "

List of organization IDs that can access the runner group.

" + }, + { + "type": "array of integers", + "name": "runners", + "in": "body", + "description": "

List of runner IDs to add to the runner group.

" + }, + { + "type": "boolean", + "name": "allows_public_repositories", + "in": "body", + "description": "

Whether the runner group can be used by public repositories.

", + "default": false + }, + { + "type": "boolean", + "name": "restricted_to_workflows", + "in": "body", + "description": "

If true, the runner group will be restricted to running only the workflows specified in the selected_workflows array.

", + "default": false + }, + { + "type": "array of strings", + "name": "selected_workflows", + "in": "body", + "description": "

List of workflows the runner group should be allowed to run. This setting will be ignored unless restricted_to_workflows is set to true.

" + }, + { + "type": "string", + "name": "network_configuration_id", + "in": "body", + "description": "

The identifier of a hosted compute network configuration.

" + } + ], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "name": "Expensive hardware runners", + "visibility": "selected", + "selected_organization_ids": [ + 32, + 91 + ], + "runners": [ + 9, + 2 + ] + }, + "parameters": { + "enterprise": "ENTERPRISE" + } + }, + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "

Response

", + "example": { + "id": 2, + "name": "octo-runner-group", + "visibility": "selected", + "default": false, + "selected_organizations_url": "https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/organizations", + "runners_url": "https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/runners", + "hosted_runners_url": "https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/hosted-runners", + "network_configuration_id": "EC486D5D793175D7E3B29C27318D5C1AAE49A7833FC85F2E82C3D2C54AC7D3BA", + "allows_public_repositories": false, + "restricted_to_workflows": true, + "selected_workflows": [ + "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" + ], + "workflow_restrictions_read_only": false + }, + "schema": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "name": { + "type": "string" + }, + "visibility": { + "type": "string" + }, + "default": { + "type": "boolean" + }, + "selected_organizations_url": { + "type": "string" + }, + "runners_url": { + "type": "string" + }, + "hosted_runners_url": { + "type": "string" + }, + "network_configuration_id": { + "description": "The identifier of a hosted compute network configuration.", + "type": "string" + }, + "allows_public_repositories": { + "type": "boolean" + }, + "workflow_restrictions_read_only": { + "description": "If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.", + "type": "boolean", + "default": false + }, + "restricted_to_workflows": { + "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", + "type": "boolean", + "default": false + }, + "selected_workflows": { + "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", + "type": "array", + "items": { + "type": "string", + "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", + "examples": [ + "octo-org/octo-repo/.github/workflows/deploy.yaml@main" + ] + } + } + }, + "required": [ + "id", + "name", + "visibility", + "allows_public_repositories", + "default", + "runners_url" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "

Creates a new self-hosted runner group for an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "201", + "description": "

Created

" + } + ] + }, { "serverUrl": "https://api.github.com", "verb": "get", - "requestPath": "/enterprises/{enterprise}/actions/runners/downloads", - "title": "List runner applications for an enterprise", + "requestPath": "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}", + "title": "Get a self-hosted runner group for an enterprise", "category": "actions", - "subcategory": "self-hosted-runners", + "subcategory": "self-hosted-runner-groups", "parameters": [ { "name": "enterprise", @@ -18249,6 +16924,15 @@ "schema": { "type": "string" } + }, + { + "name": "runner_group_id", + "description": "

Unique identifier of the self-hosted runner group.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], "bodyParameters": [], @@ -18265,99 +16949,111 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "enterprise": "ENTERPRISE" + "enterprise": "ENTERPRISE", + "runner_group_id": "RUNNER_GROUP_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "

Response

", - "example": [ - { - "os": "osx", - "architecture": "x64", - "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-osx-x64-2.164.0.tar.gz", - "filename": "actions-runner-osx-x64-2.164.0.tar.gz" - }, - { - "os": "linux", - "architecture": "x64", - "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-x64-2.164.0.tar.gz", - "filename": "actions-runner-linux-x64-2.164.0.tar.gz" - }, - { - "os": "linux", - "architecture": "arm", - "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-arm-2.164.0.tar.gz", - "filename": "actions-runner-linux-arm-2.164.0.tar.gz" - }, - { - "os": "win", - "architecture": "x64", - "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-win-x64-2.164.0.zip", - "filename": "actions-runner-win-x64-2.164.0.zip" - }, - { - "os": "linux", - "architecture": "arm64", - "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-arm64-2.164.0.tar.gz", - "filename": "actions-runner-linux-arm64-2.164.0.tar.gz" - } - ], + "example": { + "id": 2, + "name": "octo-runner-group", + "visibility": "selected", + "default": false, + "selected_organizations_url": "https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/organizations", + "runners_url": "https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/runners", + "hosted_runners_url": "https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/hosted-runners", + "network_configuration_id": "EC486D5D793175D7E3B29C27318D5C1AAE49A7833FC85F2E82C3D2C54AC7D3BA", + "allows_public_repositories": false, + "restricted_to_workflows": true, + "selected_workflows": [ + "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" + ], + "workflow_restrictions_read_only": false + }, "schema": { - "type": "array", - "items": { - "title": "Runner Application", - "description": "Runner Application", - "type": "object", - "properties": { - "os": { - "type": "string" - }, - "architecture": { - "type": "string" - }, - "download_url": { - "type": "string" - }, - "filename": { - "type": "string" - }, - "temp_download_token": { - "description": "A short lived bearer token used to download the runner, if needed.", - "type": "string" - }, - "sha256_checksum": { - "type": "string" - } + "type": "object", + "properties": { + "id": { + "type": "number" }, - "required": [ - "os", - "architecture", - "download_url", - "filename" - ] - } + "name": { + "type": "string" + }, + "visibility": { + "type": "string" + }, + "default": { + "type": "boolean" + }, + "selected_organizations_url": { + "type": "string" + }, + "runners_url": { + "type": "string" + }, + "hosted_runners_url": { + "type": "string" + }, + "network_configuration_id": { + "description": "The identifier of a hosted compute network configuration.", + "type": "string" + }, + "allows_public_repositories": { + "type": "boolean" + }, + "workflow_restrictions_read_only": { + "description": "If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.", + "type": "boolean", + "default": false + }, + "restricted_to_workflows": { + "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", + "type": "boolean", + "default": false + }, + "selected_workflows": { + "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", + "type": "array", + "items": { + "type": "string", + "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", + "examples": [ + "octo-org/octo-repo/.github/workflows/deploy.yaml@main" + ] + } + } + }, + "required": [ + "id", + "name", + "visibility", + "allows_public_repositories", + "default", + "runners_url" + ] } } } ], "previews": [], - "descriptionHTML": "

Lists binaries for the runner application that you can download and run.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Gets a specific self-hosted runner group for an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

" }, { "serverUrl": "https://api.github.com", - "verb": "post", - "requestPath": "/enterprises/{enterprise}/actions/runners/generate-jitconfig", - "title": "Create configuration for a just-in-time runner for an Enterprise", + "verb": "patch", + "requestPath": "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}", + "title": "Update a self-hosted runner group for an enterprise", "category": "actions", - "subcategory": "self-hosted-runners", + "subcategory": "self-hosted-runner-groups", "parameters": [ { "name": "enterprise", @@ -18367,6 +17063,15 @@ "schema": { "type": "string" } + }, + { + "name": "runner_group_id", + "description": "

Unique identifier of the self-hosted runner group.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], "bodyParameters": [ @@ -18374,29 +17079,44 @@ "type": "string", "name": "name", "in": "body", - "description": "

The name of the new runner.

", - "isRequired": true + "description": "

Name of the runner group.

" }, { - "type": "integer", - "name": "runner_group_id", + "type": "string", + "name": "visibility", "in": "body", - "description": "

The ID of the runner group to register the runner to.

", - "isRequired": true + "description": "

Visibility of a runner group. You can select all organizations or select individual organizations.

", + "enum": [ + "selected", + "all" + ], + "default": "all" + }, + { + "type": "boolean", + "name": "allows_public_repositories", + "in": "body", + "description": "

Whether the runner group can be used by public repositories.

", + "default": false + }, + { + "type": "boolean", + "name": "restricted_to_workflows", + "in": "body", + "description": "

If true, the runner group will be restricted to running only the workflows specified in the selected_workflows array.

", + "default": false }, { "type": "array of strings", - "name": "labels", + "name": "selected_workflows", "in": "body", - "description": "

The names of the custom labels to add to the runner. Minimum items: 1. Maximum items: 100.

", - "isRequired": true + "description": "

List of workflows the runner group should be allowed to run. This setting will be ignored unless restricted_to_workflows is set to true.

" }, { - "type": "string", - "name": "work_folder", + "type": "string or null", + "name": "network_configuration_id", "in": "body", - "description": "

The working directory to be used for job execution, relative to the runner install directory.

", - "default": "_work" + "description": "

The identifier of a hosted compute network configuration.

" } ], "progAccess": { @@ -18413,185 +17133,175 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "name": "New runner", - "runner_group_id": 1, - "labels": [ - "self-hosted", - "X64", - "macOS", - "no-gpu" - ], - "work_folder": "_work" + "name": "Expensive hardware runners", + "visibility": "selected" }, "parameters": { - "enterprise": "ENTERPRISE" + "enterprise": "ENTERPRISE", + "runner_group_id": "RUNNER_GROUP_ID" } }, "response": { - "statusCode": "201", + "statusCode": "200", "contentType": "application/json", "description": "

Response

", "example": { - "runner": { - "id": 23, - "name": "New runner", - "os": "unknown", - "status": "offline", - "busy": false, - "labels": [ - { - "id": 5, - "name": "self-hosted", - "type": "read-only" - }, - { - "id": 7, - "name": "X64", - "type": "read-only" - }, - { - "id": 20, - "name": "macOS", - "type": "read-only" - }, - { - "id": 21, - "name": "no-gpu", - "type": "custom" - } - ] - }, - "encoded_jit_config": "abc123" + "id": 2, + "name": "Expensive hardware runners", + "visibility": "selected", + "default": false, + "selected_organizations_url": "https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/organizations", + "runners_url": "https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/runners", + "hosted_runners_url": "https://api.github.com/enterprises/octo-corp/actions/runner_groups/2/hosted-runners", + "network_configuration_id": "EC486D5D793175D7E3B29C27318D5C1AAE49A7833FC85F2E82C3D2C54AC7D3BA", + "allows_public_repositories": true, + "restricted_to_workflows": false, + "selected_workflows": [ + "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" + ], + "workflow_restrictions_read_only": false }, "schema": { "type": "object", - "required": [ - "runner", - "encoded_jit_config" - ], "properties": { - "runner": { - "title": "Self hosted runners", - "description": "A self hosted runner", - "type": "object", - "properties": { - "id": { - "description": "The ID of the runner.", - "type": "integer", - "examples": [ - 5 - ] - }, - "runner_group_id": { - "description": "The ID of the runner group.", - "type": "integer", - "examples": [ - 1 - ] - }, - "name": { - "description": "The name of the runner.", - "type": "string", - "examples": [ - "iMac" - ] - }, - "os": { - "description": "The Operating System of the runner.", - "type": "string", - "examples": [ - "macos" - ] - }, - "status": { - "description": "The status of the runner.", - "type": "string", - "examples": [ - "online" - ] - }, - "busy": { - "type": "boolean" - }, - "labels": { - "type": "array", - "items": { - "title": "Self hosted runner label", - "description": "A label for a self hosted runner", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "Unique identifier of the label." - }, - "name": { - "type": "string", - "description": "Name of the label." - }, - "type": { - "type": "string", - "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", - "enum": [ - "read-only", - "custom" - ] - } - }, - "required": [ - "name" - ] - } - }, - "ephemeral": { - "type": "boolean" - } - }, - "required": [ - "id", - "name", - "os", - "status", - "busy", - "labels" - ] + "id": { + "type": "number" }, - "encoded_jit_config": { - "type": "string", - "description": "The base64 encoded runner configuration." + "name": { + "type": "string" + }, + "visibility": { + "type": "string" + }, + "default": { + "type": "boolean" + }, + "selected_organizations_url": { + "type": "string" + }, + "runners_url": { + "type": "string" + }, + "hosted_runners_url": { + "type": "string" + }, + "network_configuration_id": { + "description": "The identifier of a hosted compute network configuration.", + "type": "string" + }, + "allows_public_repositories": { + "type": "boolean" + }, + "workflow_restrictions_read_only": { + "description": "If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.", + "type": "boolean", + "default": false + }, + "restricted_to_workflows": { + "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", + "type": "boolean", + "default": false + }, + "selected_workflows": { + "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", + "type": "array", + "items": { + "type": "string", + "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", + "examples": [ + "octo-org/octo-repo/.github/workflows/deploy.yaml@main" + ] + } } - } + }, + "required": [ + "id", + "name", + "visibility", + "allows_public_repositories", + "default", + "runners_url" + ] } } } ], "previews": [], - "descriptionHTML": "

Generates a configuration that can be passed to the runner application at startup.

\n

OAuth tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", "statusCodes": [ { - "httpStatusCode": "201", - "description": "

Created

" - }, + "httpStatusCode": "200", + "description": "

OK

" + } + ], + "descriptionHTML": "

Updates the name and visibility of a self-hosted runner group in an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

" + }, + { + "serverUrl": "https://api.github.com", + "verb": "delete", + "requestPath": "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}", + "title": "Delete a self-hosted runner group from an enterprise", + "category": "actions", + "subcategory": "self-hosted-runner-groups", + "parameters": [ { - "httpStatusCode": "404", - "description": "

Resource not found

" + "name": "enterprise", + "description": "

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } }, { - "httpStatusCode": "409", - "description": "

Conflict

" - }, + "name": "runner_group_id", + "description": "

Unique identifier of the self-hosted runner group.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + }, + "codeExamples": [ { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "enterprise": "ENTERPRISE", + "runner_group_id": "RUNNER_GROUP_ID" + } + }, + "response": { + "statusCode": "204", + "description": "

Response

" + } } - ] + ], + "previews": [], + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "

No Content

" + } + ], + "descriptionHTML": "

Deletes a self-hosted runner group for an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

" }, { "serverUrl": "https://api.github.com", - "verb": "post", - "requestPath": "/enterprises/{enterprise}/actions/runners/registration-token", - "title": "Create a registration token for an enterprise", + "verb": "get", + "requestPath": "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations", + "title": "List organization access to a self-hosted runner group in an enterprise", "category": "actions", - "subcategory": "self-hosted-runners", + "subcategory": "self-hosted-runner-groups", "parameters": [ { "name": "enterprise", @@ -18601,6 +17311,33 @@ "schema": { "type": "string" } + }, + { + "name": "runner_group_id", + "description": "

Unique identifier of the self-hosted runner group.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "per_page", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } } ], "bodyParameters": [], @@ -18617,1041 +17354,765 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "enterprise": "ENTERPRISE" + "enterprise": "ENTERPRISE", + "runner_group_id": "RUNNER_GROUP_ID" } }, "response": { - "statusCode": "201", + "statusCode": "200", "contentType": "application/json", "description": "

Response

", "example": { - "token": "LLBF3JGZDX3P5PMEXLND6TS6FCWO6", - "expires_at": "2020-01-22T12:13:35.123-08:00" + "total_count": 1, + "organizations": [ + { + "login": "octocat", + "id": 161335, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "url": "https://api.github.com/orgs/octo-org", + "repos_url": "https://api.github.com/orgs/octo-org/repos", + "events_url": "https://api.github.com/orgs/octo-org/events", + "hooks_url": "https://api.github.com/orgs/octo-org/hooks", + "issues_url": "https://api.github.com/orgs/octo-org/issues", + "members_url": "https://api.github.com/orgs/octo-org/members{/member}", + "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + } + ] }, "schema": { - "title": "Authentication Token", - "description": "Authentication Token", "type": "object", "properties": { - "token": { - "description": "The token used for authentication", - "type": "string", - "examples": [ - "v1.1f699f1069f60xxx" - ] - }, - "expires_at": { - "description": "The time this token expires", - "type": "string", - "format": "date-time", - "examples": [ - "2016-07-11T22:14:10Z" - ] - }, - "permissions": { - "type": "object", - "examples": [ - { - "issues": "read", - "deployments": "write" - } - ] + "total_count": { + "type": "number" }, - "repositories": { - "description": "The repositories this token has access to", + "organizations": { "type": "array", "items": { - "title": "Repository", - "description": "A repository on GitHub.", + "title": "Organization Simple", + "description": "A GitHub organization.", "type": "object", "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", + "login": { "type": "string", "examples": [ - "Team Environment" + "github" ] }, - "full_name": { - "type": "string", + "id": { + "type": "integer", "examples": [ - "octocat/Hello-World" - ] - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + 1 ] }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { + "node_id": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], "examples": [ - "This your first repo!" + "MDEyOk9yZ2FuaXphdGlvbjE=" ] }, - "fork": { - "type": "boolean" - }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" + "https://api.github.com/orgs/github" ] }, - "downloads_url": { + "repos_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" + "https://api.github.com/orgs/github/repos" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + "https://api.github.com/orgs/github/events" ] }, - "issue_events_url": { + "hooks_url": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + "https://api.github.com/orgs/github/hooks" ] }, "issues_url": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + "https://api.github.com/orgs/github/issues" ] }, - "clone_url": { + "members_url": { "type": "string", "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" + "https://api.github.com/orgs/github/members{/member}" ] }, - "hooks_url": { + "public_members_url": { "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" + "https://api.github.com/orgs/github/public_members{/member}" ] }, - "svn_url": { + "avatar_url": { "type": "string", - "format": "uri", "examples": [ - "https://svn.github.com/octocat/Hello-World" + "https://github.com/images/error/octocat_happy.gif" ] }, - "homepage": { + "description": { "type": [ "string", "null" ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", "examples": [ - 9 + "A great organization" ] - }, - "stargazers_count": { + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + } + } + }, + "required": [ + "total_count", + "organizations" + ] + } + } + } + ], + "previews": [], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + } + ], + "descriptionHTML": "

Lists the organizations with access to a self-hosted runner group.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

" + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations", + "title": "Set organization access for a self-hosted runner group in an enterprise", + "category": "actions", + "subcategory": "self-hosted-runner-groups", + "parameters": [ + { + "name": "enterprise", + "description": "

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "runner_group_id", + "description": "

Unique identifier of the self-hosted runner group.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [ + { + "type": "array of integers", + "name": "selected_organization_ids", + "in": "body", + "description": "

List of organization IDs that can access the runner group.

", + "isRequired": true + } + ], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "selected_organization_ids": [ + 32, + 91 + ] + }, + "parameters": { + "enterprise": "ENTERPRISE", + "runner_group_id": "RUNNER_GROUP_ID" + } + }, + "response": { + "statusCode": "204", + "description": "

Response

" + } + } + ], + "previews": [], + "descriptionHTML": "

Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "

No Content

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations/{org_id}", + "title": "Add organization access to a self-hosted runner group in an enterprise", + "category": "actions", + "subcategory": "self-hosted-runner-groups", + "parameters": [ + { + "name": "enterprise", + "description": "

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "runner_group_id", + "description": "

Unique identifier of the self-hosted runner group.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "org_id", + "description": "

The unique identifier of the organization.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "enterprise": "ENTERPRISE", + "runner_group_id": "RUNNER_GROUP_ID", + "org_id": "ORG_ID" + } + }, + "response": { + "statusCode": "204", + "description": "

Response

" + } + } + ], + "previews": [], + "descriptionHTML": "

Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have visibility set to selected. For more information, see \"Create a self-hosted runner group for an enterprise.\"

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "

No Content

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "delete", + "requestPath": "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations/{org_id}", + "title": "Remove organization access to a self-hosted runner group in an enterprise", + "category": "actions", + "subcategory": "self-hosted-runner-groups", + "parameters": [ + { + "name": "enterprise", + "description": "

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "runner_group_id", + "description": "

Unique identifier of the self-hosted runner group.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "org_id", + "description": "

The unique identifier of the organization.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "enterprise": "ENTERPRISE", + "runner_group_id": "RUNNER_GROUP_ID", + "org_id": "ORG_ID" + } + }, + "response": { + "statusCode": "204", + "description": "

Response

" + } + } + ], + "previews": [], + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "

No Content

" + } + ], + "descriptionHTML": "

Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have visibility set to selected. For more information, see \"Create a self-hosted runner group for an enterprise.\"

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

" + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners", + "title": "List self-hosted runners in a group for an enterprise", + "category": "actions", + "subcategory": "self-hosted-runner-groups", + "parameters": [ + { + "name": "enterprise", + "description": "

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "runner_group_id", + "description": "

Unique identifier of the self-hosted runner group.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "per_page", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "enterprise": "ENTERPRISE", + "runner_group_id": "RUNNER_GROUP_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "total_count": 2, + "runners": [ + { + "id": 23, + "name": "linux_runner", + "os": "linux", + "status": "online", + "busy": true, + "ephemeral": false, + "labels": [ + { + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 11, + "name": "Linux", + "type": "read-only" + } + ] + }, + { + "id": 24, + "name": "mac_runner", + "os": "macos", + "status": "offline", + "busy": false, + "ephemeral": false, + "labels": [ + { + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 20, + "name": "macOS", + "type": "read-only" + }, + { + "id": 21, + "name": "no-gpu", + "type": "custom" + } + ] + } + ] + }, + "schema": { + "type": "object", + "properties": { + "total_count": { + "type": "number" + }, + "runners": { + "type": "array", + "items": { + "title": "Self hosted runners", + "description": "A self hosted runner", + "type": "object", + "properties": { + "id": { + "description": "The ID of the runner.", "type": "integer", "examples": [ - 80 + 5 ] }, - "watchers_count": { + "runner_group_id": { + "description": "The ID of the runner group.", "type": "integer", "examples": [ - 80 + 1 ] }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", + "name": { + "description": "The name of the runner.", + "type": "string", "examples": [ - 108 + "iMac" ] }, - "default_branch": { - "description": "The default branch of the repository.", + "os": { + "description": "The Operating System of the runner.", "type": "string", "examples": [ - "master" + "macos" ] }, - "open_issues_count": { - "type": "integer", + "status": { + "description": "The status of the runner.", + "type": "string", "examples": [ - 0 + "online" ] }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "examples": [ - true - ] + "busy": { + "type": "boolean" }, - "topics": { + "labels": { "type": "array", "items": { - "type": "string" + "title": "Self hosted runner label", + "description": "A label for a self hosted runner", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier of the label." + }, + "name": { + "type": "string", + "description": "Name of the label." + }, + "type": { + "type": "string", + "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", + "enum": [ + "read-only", + "custom" + ] + } + }, + "required": [ + "name" + ] } }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true, - "examples": [ - true - ] - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, + "ephemeral": { "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:42Z\"" - ] - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "type": "string" - } - } } }, "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_downloads", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", - "created_at", - "updated_at" + "os", + "status", + "busy", + "labels" ] } - }, - "single_file": { - "type": [ - "string", - "null" - ], - "examples": [ - "config.yaml" - ] - }, - "repository_selection": { - "description": "Describe whether all repositories have been selected or there's a selection involved", - "type": "string", - "enum": [ - "all", - "selected" - ] } }, "required": [ - "token", - "expires_at" + "total_count", + "runners" ] } } } ], "previews": [], - "descriptionHTML": "

Returns a token that you can pass to the config script. The token expires after one hour.

\n

Example using registration token:

\n

Configure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.

\n
./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n
\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", "statusCodes": [ { - "httpStatusCode": "201", - "description": "

Created

" + "httpStatusCode": "200", + "description": "

OK

" + } + ], + "descriptionHTML": "

Lists the self-hosted runners that are in a specific enterprise group.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

" + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners", + "title": "Set self-hosted runners in a group for an enterprise", + "category": "actions", + "subcategory": "self-hosted-runner-groups", + "parameters": [ + { + "name": "enterprise", + "description": "

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "runner_group_id", + "description": "

Unique identifier of the self-hosted runner group.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [ + { + "type": "array of integers", + "name": "runners", + "in": "body", + "description": "

List of runner IDs to add to the runner group.

", + "isRequired": true + } + ], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "runners": [ + 9, + 2 + ] + }, + "parameters": { + "enterprise": "ENTERPRISE", + "runner_group_id": "RUNNER_GROUP_ID" + } + }, + "response": { + "statusCode": "204", + "description": "

Response

" + } + } + ], + "previews": [], + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "

No Content

" + } + ], + "descriptionHTML": "

Replaces the list of self-hosted runners that are part of an enterprise runner group.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

" + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}", + "title": "Add a self-hosted runner to a group for an enterprise", + "category": "actions", + "subcategory": "self-hosted-runner-groups", + "parameters": [ + { + "name": "enterprise", + "description": "

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "runner_group_id", + "description": "

Unique identifier of the self-hosted runner group.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "runner_id", + "description": "

Unique identifier of the self-hosted runner.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "enterprise": "ENTERPRISE", + "runner_group_id": "RUNNER_GROUP_ID", + "runner_id": "RUNNER_ID" + } + }, + "response": { + "statusCode": "204", + "description": "

Response

" + } + } + ], + "previews": [], + "descriptionHTML": "

Adds a self-hosted runner to a runner group configured in an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "

No Content

" } ] }, { "serverUrl": "https://api.github.com", - "verb": "post", - "requestPath": "/enterprises/{enterprise}/actions/runners/remove-token", - "title": "Create a remove token for an enterprise", + "verb": "delete", + "requestPath": "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}", + "title": "Remove a self-hosted runner from a group for an enterprise", "category": "actions", - "subcategory": "self-hosted-runners", + "subcategory": "self-hosted-runner-groups", "parameters": [ { "name": "enterprise", @@ -19661,6 +18122,24 @@ "schema": { "type": "string" } + }, + { + "name": "runner_group_id", + "description": "

Unique identifier of the self-hosted runner group.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "runner_id", + "description": "

Unique identifier of the self-hosted runner.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], "bodyParameters": [], @@ -19677,1285 +18156,463 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "enterprise": "ENTERPRISE" + "enterprise": "ENTERPRISE", + "runner_group_id": "RUNNER_GROUP_ID", + "runner_id": "RUNNER_ID" } }, "response": { - "statusCode": "201", + "statusCode": "204", + "description": "

Response

" + } + } + ], + "previews": [], + "descriptionHTML": "

Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "

No Content

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/actions/runner-groups", + "title": "List self-hosted runner groups for an organization", + "category": "actions", + "subcategory": "self-hosted-runner-groups", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "visible_to_repository", + "description": "

Only return runner groups that are allowed to be used by this repository.

", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Self-hosted runners\" organization permissions": "read" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "200", "contentType": "application/json", "description": "

Response

", "example": { - "token": "AABF3JGZDX3P5PMEXLND6TS6FCWO6", - "expires_at": "2020-01-29T12:13:35.123-08:00" + "total_count": 3, + "runner_groups": [ + { + "id": 1, + "name": "Default", + "visibility": "all", + "default": true, + "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/1/runners", + "inherited": false, + "allows_public_repositories": true, + "restricted_to_workflows": false, + "selected_workflows": [], + "workflow_restrictions_read_only": false + }, + { + "id": 2, + "name": "octo-runner-group", + "visibility": "selected", + "default": false, + "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/repositories", + "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners", + "inherited": true, + "allows_public_repositories": true, + "restricted_to_workflows": true, + "selected_workflows": [ + "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" + ], + "workflow_restrictions_read_only": true + }, + { + "id": 3, + "name": "expensive-hardware", + "visibility": "private", + "default": false, + "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/3/runners", + "inherited": false, + "allows_public_repositories": true, + "restricted_to_workflows": false, + "selected_workflows": [ + "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" + ], + "workflow_restrictions_read_only": false + } + ] }, "schema": { - "title": "Authentication Token", - "description": "Authentication Token", "type": "object", + "required": [ + "total_count", + "runner_groups" + ], "properties": { - "token": { - "description": "The token used for authentication", - "type": "string", - "examples": [ - "v1.1f699f1069f60xxx" - ] - }, - "expires_at": { - "description": "The time this token expires", - "type": "string", - "format": "date-time", - "examples": [ - "2016-07-11T22:14:10Z" - ] - }, - "permissions": { - "type": "object", - "examples": [ - { - "issues": "read", - "deployments": "write" - } - ] + "total_count": { + "type": "number" }, - "repositories": { - "description": "The repositories this token has access to", + "runner_groups": { "type": "array", "items": { - "title": "Repository", - "description": "A repository on GitHub.", "type": "object", "properties": { "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] + "type": "number" }, "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] + "type": "string" }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] + "visibility": { + "type": "string" }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] + "default": { + "type": "boolean" }, - "forks": { - "type": "integer" + "selected_repositories_url": { + "description": "Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected`", + "type": "string" }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] + "runners_url": { + "type": "string" }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] + "hosted_runners_url": { + "type": "string" }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" + "network_configuration_id": { + "description": "The identifier of a hosted compute network configuration.", + "type": "string" }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] + "inherited": { + "type": "boolean" }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] + "inherited_allows_public_repositories": { + "type": "boolean" }, - "fork": { + "allows_public_repositories": { "type": "boolean" }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] + "workflow_restrictions_read_only": { + "description": "If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.", + "type": "boolean", + "default": false }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] + "restricted_to_workflows": { + "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", + "type": "boolean", + "default": false }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "examples": [ - 108 - ] - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "examples": [ - "master" - ] - }, - "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "topics": { + "selected_workflows": { + "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", "type": "array", "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true, - "examples": [ - true - ] - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:42Z\"" - ] - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "type": "string" - } + "type": "string", + "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", + "examples": [ + "octo-org/octo-repo/.github/workflows/deploy.yaml@main" + ] } } }, "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_downloads", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", - "created_at", - "updated_at" + "visibility", + "default", + "runners_url", + "inherited", + "allows_public_repositories" ] } - }, - "single_file": { - "type": [ - "string", - "null" - ], - "examples": [ - "config.yaml" - ] - }, - "repository_selection": { - "description": "Describe whether all repositories have been selected or there's a selection involved", - "type": "string", - "enum": [ - "all", - "selected" - ] } - }, - "required": [ - "token", - "expires_at" - ] + } } } } ], "previews": [], - "descriptionHTML": "

Returns a token that you can pass to the config script to remove a self-hosted runner from an enterprise. The token expires after one hour.

\n

Example using remove token:

\n

To remove your self-hosted runner from an enterprise, replace TOKEN with the remove token provided by this\nendpoint.

\n
./config.sh remove --token TOKEN\n
\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", + "descriptionHTML": "

Lists all self-hosted runner groups configured in an organization and inherited from an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { - "httpStatusCode": "201", - "description": "

Created

" + "httpStatusCode": "200", + "description": "

OK

" } ] }, { "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/enterprises/{enterprise}/actions/runners/{runner_id}", - "title": "Get a self-hosted runner for an enterprise", + "verb": "post", + "requestPath": "/orgs/{org}/actions/runner-groups", + "title": "Create a self-hosted runner group for an organization", "category": "actions", - "subcategory": "self-hosted-runners", + "subcategory": "self-hosted-runner-groups", "parameters": [ { - "name": "enterprise", - "description": "

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

", + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", "in": "path", "required": true, "schema": { "type": "string" } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "name", + "in": "body", + "description": "

Name of the runner group.

", + "isRequired": true }, { - "name": "runner_id", - "description": "

Unique identifier of the self-hosted runner.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } + "type": "string", + "name": "visibility", + "in": "body", + "description": "

Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories.

", + "enum": [ + "selected", + "all", + "private" + ], + "default": "all" + }, + { + "type": "array of integers", + "name": "selected_repository_ids", + "in": "body", + "description": "

List of repository IDs that can access the runner group.

" + }, + { + "type": "array of integers", + "name": "runners", + "in": "body", + "description": "

List of runner IDs to add to the runner group.

" + }, + { + "type": "boolean", + "name": "allows_public_repositories", + "in": "body", + "description": "

Whether the runner group can be used by public repositories.

", + "default": false + }, + { + "type": "boolean", + "name": "restricted_to_workflows", + "in": "body", + "description": "

If true, the runner group will be restricted to running only the workflows specified in the selected_workflows array.

", + "default": false + }, + { + "type": "array of strings", + "name": "selected_workflows", + "in": "body", + "description": "

List of workflows the runner group should be allowed to run. This setting will be ignored unless restricted_to_workflows is set to true.

" + }, + { + "type": "string", + "name": "network_configuration_id", + "in": "body", + "description": "

The identifier of a hosted compute network configuration.

" } ], - "bodyParameters": [], "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Self-hosted runners\" organization permissions": "write" + } + ] }, "codeExamples": [ { "key": "default", "request": { + "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "name": "Expensive hardware runners", + "visibility": "selected", + "selected_repository_ids": [ + 32, + 91 + ], + "runners": [ + 9, + 2 + ] + }, "parameters": { - "enterprise": "ENTERPRISE", - "runner_id": "RUNNER_ID" + "org": "ORG" } }, "response": { - "statusCode": "200", + "statusCode": "201", "contentType": "application/json", "description": "

Response

", "example": { - "id": 23, - "name": "MBP", - "os": "macos", - "status": "online", - "busy": true, - "ephemeral": false, - "labels": [ - { - "id": 5, - "name": "self-hosted", - "type": "read-only" - }, - { - "id": 7, - "name": "X64", - "type": "read-only" - }, - { - "id": 20, - "name": "macOS", - "type": "read-only" - }, - { - "id": 21, - "name": "no-gpu", - "type": "custom" - } - ] + "id": 2, + "name": "octo-runner-group", + "visibility": "selected", + "default": false, + "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner-groups/2/repositories", + "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners", + "hosted_runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/hosted-runners", + "network_configuration_id": "EC486D5D793175D7E3B29C27318D5C1AAE49A7833FC85F2E82C3D2C54AC7D3BA", + "inherited": false, + "allows_public_repositories": true, + "restricted_to_workflows": true, + "selected_workflows": [ + "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" + ], + "workflow_restrictions_read_only": false }, "schema": { - "title": "Self hosted runners", - "description": "A self hosted runner", "type": "object", "properties": { "id": { - "description": "The ID of the runner.", - "type": "integer", - "examples": [ - 5 - ] - }, - "runner_group_id": { - "description": "The ID of the runner group.", - "type": "integer", - "examples": [ - 1 - ] + "type": "number" }, "name": { - "description": "The name of the runner.", - "type": "string", - "examples": [ - "iMac" - ] + "type": "string" }, - "os": { - "description": "The Operating System of the runner.", - "type": "string", - "examples": [ - "macos" - ] + "visibility": { + "type": "string" }, - "status": { - "description": "The status of the runner.", - "type": "string", - "examples": [ - "online" - ] + "default": { + "type": "boolean" }, - "busy": { + "selected_repositories_url": { + "description": "Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected`", + "type": "string" + }, + "runners_url": { + "type": "string" + }, + "hosted_runners_url": { + "type": "string" + }, + "network_configuration_id": { + "description": "The identifier of a hosted compute network configuration.", + "type": "string" + }, + "inherited": { "type": "boolean" }, - "labels": { + "inherited_allows_public_repositories": { + "type": "boolean" + }, + "allows_public_repositories": { + "type": "boolean" + }, + "workflow_restrictions_read_only": { + "description": "If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.", + "type": "boolean", + "default": false + }, + "restricted_to_workflows": { + "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", + "type": "boolean", + "default": false + }, + "selected_workflows": { + "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", "type": "array", "items": { - "title": "Self hosted runner label", - "description": "A label for a self hosted runner", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "Unique identifier of the label." - }, - "name": { - "type": "string", - "description": "Name of the label." - }, - "type": { - "type": "string", - "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", - "enum": [ - "read-only", - "custom" - ] - } - }, - "required": [ - "name" + "type": "string", + "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", + "examples": [ + "octo-org/octo-repo/.github/workflows/deploy.yaml@main" ] } - }, - "ephemeral": { - "type": "boolean" } }, "required": [ "id", "name", - "os", - "status", - "busy", - "labels" + "visibility", + "default", + "runners_url", + "inherited", + "allows_public_repositories" ] } } } ], "previews": [], - "descriptionHTML": "

Gets a specific self-hosted runner configured in an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "delete", - "requestPath": "/enterprises/{enterprise}/actions/runners/{runner_id}", - "title": "Delete a self-hosted runner from an enterprise", - "category": "actions", - "subcategory": "self-hosted-runners", - "parameters": [ - { - "name": "enterprise", - "description": "

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "runner_id", - "description": "

Unique identifier of the self-hosted runner.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - }, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "enterprise": "ENTERPRISE", - "runner_id": "RUNNER_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "previews": [], - "descriptionHTML": "

Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", + "descriptionHTML": "

Creates a new self-hosted runner group for an organization.

\n

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" + "httpStatusCode": "201", + "description": "

Created

" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", - "requestPath": "/enterprises/{enterprise}/actions/runners/{runner_id}/labels", - "title": "List labels for a self-hosted runner for an enterprise", + "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}", + "title": "Get a self-hosted runner group for an organization", "category": "actions", - "subcategory": "self-hosted-runners", + "subcategory": "self-hosted-runner-groups", "parameters": [ { - "name": "enterprise", - "description": "

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

", + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", "in": "path", "required": true, "schema": { @@ -20963,8 +18620,8 @@ } }, { - "name": "runner_id", - "description": "

Unique identifier of the self-hosted runner.

", + "name": "runner_group_id", + "description": "

Unique identifier of the self-hosted runner group.

", "in": "path", "required": true, "schema": { @@ -20974,10 +18631,14 @@ ], "bodyParameters": [], "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Self-hosted runners\" organization permissions": "read" + } + ] }, "codeExamples": [ { @@ -20986,8 +18647,8 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "enterprise": "ENTERPRISE", - "runner_id": "RUNNER_ID" + "org": "ORG", + "runner_group_id": "RUNNER_GROUP_ID" } }, "response": { @@ -20995,98 +18656,115 @@ "contentType": "application/json", "description": "

Response

", "example": { - "total_count": 4, - "labels": [ - { - "id": 5, - "name": "self-hosted", - "type": "read-only" - }, - { - "id": 7, - "name": "X64", - "type": "read-only" - }, - { - "id": 20, - "name": "macOS", - "type": "read-only" - }, - { - "id": 21, - "name": "no-gpu", - "type": "custom" - } - ] + "id": 2, + "name": "octo-runner-group", + "visibility": "selected", + "default": false, + "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/repositories", + "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners", + "hosted_runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/hosted-runners", + "network_configuration_id": "EC486D5D793175D7E3B29C27318D5C1AAE49A7833FC85F2E82C3D2C54AC7D3BA", + "inherited": false, + "allows_public_repositories": true, + "restricted_to_workflows": true, + "selected_workflows": [ + "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" + ], + "workflow_restrictions_read_only": false }, "schema": { "type": "object", - "required": [ - "total_count", - "labels" - ], "properties": { - "total_count": { - "type": "integer" + "id": { + "type": "number" }, - "labels": { + "name": { + "type": "string" + }, + "visibility": { + "type": "string" + }, + "default": { + "type": "boolean" + }, + "selected_repositories_url": { + "description": "Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected`", + "type": "string" + }, + "runners_url": { + "type": "string" + }, + "hosted_runners_url": { + "type": "string" + }, + "network_configuration_id": { + "description": "The identifier of a hosted compute network configuration.", + "type": "string" + }, + "inherited": { + "type": "boolean" + }, + "inherited_allows_public_repositories": { + "type": "boolean" + }, + "allows_public_repositories": { + "type": "boolean" + }, + "workflow_restrictions_read_only": { + "description": "If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.", + "type": "boolean", + "default": false + }, + "restricted_to_workflows": { + "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", + "type": "boolean", + "default": false + }, + "selected_workflows": { + "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", "type": "array", "items": { - "title": "Self hosted runner label", - "description": "A label for a self hosted runner", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "Unique identifier of the label." - }, - "name": { - "type": "string", - "description": "Name of the label." - }, - "type": { - "type": "string", - "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", - "enum": [ - "read-only", - "custom" - ] - } - }, - "required": [ - "name" + "type": "string", + "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", + "examples": [ + "octo-org/octo-repo/.github/workflows/deploy.yaml@main" ] } } - } + }, + "required": [ + "id", + "name", + "visibility", + "default", + "runners_url", + "inherited", + "allows_public_repositories" + ] } } } ], "previews": [], - "descriptionHTML": "

Lists all labels for a self-hosted runner configured in an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" } - ] + ], + "descriptionHTML": "

Gets a specific self-hosted runner group for an organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" }, { "serverUrl": "https://api.github.com", - "verb": "post", - "requestPath": "/enterprises/{enterprise}/actions/runners/{runner_id}/labels", - "title": "Add custom labels to a self-hosted runner for an enterprise", + "verb": "patch", + "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}", + "title": "Update a self-hosted runner group for an organization", "category": "actions", - "subcategory": "self-hosted-runners", + "subcategory": "self-hosted-runner-groups", "parameters": [ { - "name": "enterprise", - "description": "

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

", + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", "in": "path", "required": true, "schema": { @@ -21094,8 +18772,8 @@ } }, { - "name": "runner_id", - "description": "

Unique identifier of the self-hosted runner.

", + "name": "runner_group_id", + "description": "

Unique identifier of the self-hosted runner group.

", "in": "path", "required": true, "schema": { @@ -21105,168 +18783,59 @@ ], "bodyParameters": [ { - "type": "array of strings", - "name": "labels", + "type": "string", + "name": "name", "in": "body", - "description": "

The names of the custom labels to add to the runner.

", + "description": "

Name of the runner group.

", "isRequired": true - } - ], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - }, - "codeExamples": [ - { - "key": "default", - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "labels": [ - "gpu", - "accelerated" - ] - }, - "parameters": { - "enterprise": "ENTERPRISE", - "runner_id": "RUNNER_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "total_count": 4, - "labels": [ - { - "id": 5, - "name": "self-hosted", - "type": "read-only" - }, - { - "id": 7, - "name": "X64", - "type": "read-only" - }, - { - "id": 20, - "name": "macOS", - "type": "read-only" - }, - { - "id": 21, - "name": "no-gpu", - "type": "custom" - } - ] - }, - "schema": { - "type": "object", - "required": [ - "total_count", - "labels" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "labels": { - "type": "array", - "items": { - "title": "Self hosted runner label", - "description": "A label for a self hosted runner", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "Unique identifier of the label." - }, - "name": { - "type": "string", - "description": "Name of the label." - }, - "type": { - "type": "string", - "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", - "enum": [ - "read-only", - "custom" - ] - } - }, - "required": [ - "name" - ] - } - } - } - } - } - } - ], - "previews": [], - "descriptionHTML": "

Add custom labels to a self-hosted runner configured in an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" }, { - "httpStatusCode": "404", - "description": "

Resource not found

" + "type": "string", + "name": "visibility", + "in": "body", + "description": "

Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories.

", + "enum": [ + "selected", + "all", + "private" + ] }, { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "put", - "requestPath": "/enterprises/{enterprise}/actions/runners/{runner_id}/labels", - "title": "Set custom labels for a self-hosted runner for an enterprise", - "category": "actions", - "subcategory": "self-hosted-runners", - "parameters": [ - { - "name": "enterprise", - "description": "

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } + "type": "boolean", + "name": "allows_public_repositories", + "in": "body", + "description": "

Whether the runner group can be used by public repositories.

", + "default": false }, { - "name": "runner_id", - "description": "

Unique identifier of the self-hosted runner.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ + "type": "boolean", + "name": "restricted_to_workflows", + "in": "body", + "description": "

If true, the runner group will be restricted to running only the workflows specified in the selected_workflows array.

", + "default": false + }, { "type": "array of strings", - "name": "labels", + "name": "selected_workflows", "in": "body", - "description": "

The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.

", - "isRequired": true + "description": "

List of workflows the runner group should be allowed to run. This setting will be ignored unless restricted_to_workflows is set to true.

" + }, + { + "type": "string or null", + "name": "network_configuration_id", + "in": "body", + "description": "

The identifier of a hosted compute network configuration.

" } ], "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Self-hosted runners\" organization permissions": "write" + } + ] }, "codeExamples": [ { @@ -21276,14 +18845,12 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "labels": [ - "gpu", - "accelerated" - ] + "name": "Expensive hardware runners", + "visibility": "selected" }, "parameters": { - "enterprise": "ENTERPRISE", - "runner_id": "RUNNER_ID" + "org": "ORG", + "runner_group_id": "RUNNER_GROUP_ID" } }, "response": { @@ -21291,102 +18858,115 @@ "contentType": "application/json", "description": "

Response

", "example": { - "total_count": 4, - "labels": [ - { - "id": 5, - "name": "self-hosted", - "type": "read-only" - }, - { - "id": 7, - "name": "X64", - "type": "read-only" - }, - { - "id": 20, - "name": "macOS", - "type": "read-only" - }, - { - "id": 21, - "name": "no-gpu", - "type": "custom" - } - ] + "id": 2, + "name": "octo-runner-group", + "visibility": "selected", + "default": false, + "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner-groups/2/repositories", + "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners", + "hosted_runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/hosted-runners", + "network_configuration_id": "EC486D5D793175D7E3B29C27318D5C1AAE49A7833FC85F2E82C3D2C54AC7D3BA", + "inherited": false, + "allows_public_repositories": true, + "restricted_to_workflows": true, + "selected_workflows": [ + "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" + ], + "workflow_restrictions_read_only": false }, "schema": { "type": "object", - "required": [ - "total_count", - "labels" - ], "properties": { - "total_count": { - "type": "integer" + "id": { + "type": "number" }, - "labels": { + "name": { + "type": "string" + }, + "visibility": { + "type": "string" + }, + "default": { + "type": "boolean" + }, + "selected_repositories_url": { + "description": "Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected`", + "type": "string" + }, + "runners_url": { + "type": "string" + }, + "hosted_runners_url": { + "type": "string" + }, + "network_configuration_id": { + "description": "The identifier of a hosted compute network configuration.", + "type": "string" + }, + "inherited": { + "type": "boolean" + }, + "inherited_allows_public_repositories": { + "type": "boolean" + }, + "allows_public_repositories": { + "type": "boolean" + }, + "workflow_restrictions_read_only": { + "description": "If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.", + "type": "boolean", + "default": false + }, + "restricted_to_workflows": { + "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", + "type": "boolean", + "default": false + }, + "selected_workflows": { + "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", "type": "array", "items": { - "title": "Self hosted runner label", - "description": "A label for a self hosted runner", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "Unique identifier of the label." - }, - "name": { - "type": "string", - "description": "Name of the label." - }, - "type": { - "type": "string", - "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", - "enum": [ - "read-only", - "custom" - ] - } - }, - "required": [ - "name" + "type": "string", + "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", + "examples": [ + "octo-org/octo-repo/.github/workflows/deploy.yaml@main" ] } } - } + }, + "required": [ + "id", + "name", + "visibility", + "default", + "runners_url", + "inherited", + "allows_public_repositories" + ] } } } ], "previews": [], - "descriptionHTML": "

Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", + "descriptionHTML": "

Updates the name and visibility of a self-hosted runner group in an organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", - "requestPath": "/enterprises/{enterprise}/actions/runners/{runner_id}/labels", - "title": "Remove all custom labels from a self-hosted runner for an enterprise", + "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}", + "title": "Delete a self-hosted runner group from an organization", "category": "actions", - "subcategory": "self-hosted-runners", + "subcategory": "self-hosted-runner-groups", "parameters": [ { - "name": "enterprise", - "description": "

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

", + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", "in": "path", "required": true, "schema": { @@ -21394,8 +18974,8 @@ } }, { - "name": "runner_id", - "description": "

Unique identifier of the self-hosted runner.

", + "name": "runner_group_id", + "description": "

Unique identifier of the self-hosted runner group.

", "in": "path", "required": true, "schema": { @@ -21405,10 +18985,14 @@ ], "bodyParameters": [], "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Self-hosted runners\" organization permissions": "write" + } + ] }, "codeExamples": [ { @@ -21417,106 +19001,36 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "enterprise": "ENTERPRISE", - "runner_id": "RUNNER_ID" + "org": "ORG", + "runner_group_id": "RUNNER_GROUP_ID" } }, "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "total_count": 3, - "labels": [ - { - "id": 5, - "name": "self-hosted", - "type": "read-only" - }, - { - "id": 7, - "name": "X64", - "type": "read-only" - }, - { - "id": 20, - "name": "macOS", - "type": "read-only" - } - ] - }, - "schema": { - "type": "object", - "required": [ - "total_count", - "labels" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "labels": { - "type": "array", - "items": { - "title": "Self hosted runner label", - "description": "A label for a self hosted runner", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "Unique identifier of the label." - }, - "name": { - "type": "string", - "description": "Name of the label." - }, - "type": { - "type": "string", - "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", - "enum": [ - "read-only", - "custom" - ] - } - }, - "required": [ - "name" - ] - } - } - } - } + "statusCode": "204", + "description": "

Response

" } } ], "previews": [], - "descriptionHTML": "

Remove all custom labels from a self-hosted runner configured in an\nenterprise. Returns the remaining read-only labels from the runner.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", + "descriptionHTML": "

Deletes a self-hosted runner group for an organization.

\n

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" + "httpStatusCode": "204", + "description": "

No Content

" } ] }, { "serverUrl": "https://api.github.com", - "verb": "delete", - "requestPath": "/enterprises/{enterprise}/actions/runners/{runner_id}/labels/{name}", - "title": "Remove a custom label from a self-hosted runner for an enterprise", + "verb": "get", + "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/hosted-runners", + "title": "List GitHub-hosted runners in a group for an organization", "category": "actions", - "subcategory": "self-hosted-runners", + "subcategory": "self-hosted-runner-groups", "parameters": [ { - "name": "enterprise", - "description": "

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

", + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", "in": "path", "required": true, "schema": { @@ -21524,8 +19038,8 @@ } }, { - "name": "runner_id", - "description": "

Unique identifier of the self-hosted runner.

", + "name": "runner_group_id", + "description": "

Unique identifier of the self-hosted runner group.

", "in": "path", "required": true, "schema": { @@ -21533,21 +19047,34 @@ } }, { - "name": "name", - "description": "

The name of a self-hosted runner's custom label.

", - "in": "path", - "required": true, + "name": "per_page", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "in": "query", "schema": { - "type": "string" + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "in": "query", + "schema": { + "type": "integer", + "default": 1 } } ], "bodyParameters": [], "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Self-hosted runners\" organization permissions": "read" + } + ] }, "codeExamples": [ { @@ -21556,9 +19083,8 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "enterprise": "ENTERPRISE", - "runner_id": "RUNNER_ID", - "name": "NAME" + "org": "ORG", + "runner_group_id": "RUNNER_GROUP_ID" } }, "response": { @@ -21566,27 +19092,55 @@ "contentType": "application/json", "description": "

Response

", "example": { - "total_count": 4, - "labels": [ + "total_count": 2, + "runners": [ { "id": 5, - "name": "self-hosted", - "type": "read-only" + "name": "My hosted ubuntu runner", + "runner_group_id": 2, + "platform": "linux-x64", + "image": { + "id": "ubuntu-20.04", + "size": 86 + }, + "machine_size_details": { + "id": "4-core", + "cpu_cores": 4, + "memory_gb": 16, + "storage_gb": 150 + }, + "status": "Ready", + "maximum_runners": 10, + "public_ip_enabled": true, + "public_ips": [ + { + "enabled": true, + "prefix": "20.80.208.150", + "length": 31 + } + ], + "last_active_on": "2022-10-09T23:39:01Z" }, { "id": 7, - "name": "X64", - "type": "read-only" - }, - { - "id": 20, - "name": "macOS", - "type": "read-only" - }, - { - "id": 21, - "name": "no-gpu", - "type": "custom" + "name": "My hosted Windows runner", + "runner_group_id": 2, + "platform": "win-x64", + "image": { + "id": "windows-latest", + "size": 256 + }, + "machine_size_details": { + "id": "8-core", + "cpu_cores": 8, + "memory_gb": 32, + "storage_gb": 300 + }, + "status": "Ready", + "maximum_runners": 20, + "public_ip_enabled": false, + "public_ips": [], + "last_active_on": "2023-04-26T15:23:37Z" } ] }, @@ -21594,38 +19148,219 @@ "type": "object", "required": [ "total_count", - "labels" + "runners" ], "properties": { "total_count": { - "type": "integer" + "type": "number" }, - "labels": { + "runners": { "type": "array", "items": { - "title": "Self hosted runner label", - "description": "A label for a self hosted runner", + "title": "GitHub-hosted hosted runner", + "description": "A Github-hosted hosted runner.", "type": "object", "properties": { "id": { + "description": "The unique identifier of the hosted runner.", "type": "integer", - "description": "Unique identifier of the label." + "examples": [ + 5 + ] }, "name": { + "description": "The name of the hosted runner.", "type": "string", - "description": "Name of the label." + "examples": [ + "my-github-hosted-runner" + ] }, - "type": { + "runner_group_id": { + "description": "The unique identifier of the group that the hosted runner belongs to.", + "type": "integer", + "examples": [ + 2 + ] + }, + "image_details": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub-hosted runner image details.", + "description": "Provides details of a hosted runner image", + "type": "object", + "properties": { + "id": { + "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", + "type": "string", + "examples": [ + "ubuntu-20.04" + ] + }, + "size_gb": { + "description": "Image size in GB.", + "type": "integer", + "examples": [ + 86 + ] + }, + "display_name": { + "description": "Display name for this image.", + "type": "string", + "examples": [ + 20.04 + ] + }, + "source": { + "description": "The image provider.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + } + }, + "required": [ + "id", + "size_gb", + "display_name", + "source" + ] + } + ] + }, + "machine_size_details": { + "title": "Github-owned VM details.", + "description": "Provides details of a particular machine spec.", + "type": "object", + "properties": { + "id": { + "description": "The ID used for the `size` parameter when creating a new runner.", + "type": "string", + "examples": [ + "8-core" + ] + }, + "cpu_cores": { + "description": "The number of cores.", + "type": "integer", + "examples": [ + 8 + ] + }, + "memory_gb": { + "description": "The available RAM for the machine spec.", + "type": "integer", + "examples": [ + 32 + ] + }, + "storage_gb": { + "description": "The available SSD storage for the machine spec.", + "type": "integer", + "examples": [ + 300 + ] + } + }, + "required": [ + "id", + "cpu_cores", + "memory_gb", + "storage_gb" + ] + }, + "status": { + "description": "The status of the runner.", "type": "string", - "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", "enum": [ - "read-only", - "custom" + "Ready", + "Provisioning", + "Shutdown", + "Deleting", + "Stuck" + ], + "examples": [ + "Ready" + ] + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "examples": [ + "linux-x64" + ] + }, + "maximum_runners": { + "description": "The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost.", + "type": "integer", + "default": 10, + "examples": [ + 5 + ] + }, + "public_ip_enabled": { + "description": "Whether public IP is enabled for the hosted runners.", + "type": "boolean", + "examples": [ + true + ] + }, + "public_ips": { + "description": "The public IP ranges when public IP is enabled for the hosted runners.", + "type": "array", + "items": { + "title": "Public IP for a GitHub-hosted larger runners.", + "description": "Provides details of Public IP for a GitHub-hosted larger runners", + "type": "object", + "properties": { + "enabled": { + "description": "Whether public IP is enabled.", + "type": "boolean", + "examples": [ + true + ] + }, + "prefix": { + "description": "The prefix for the public IP.", + "type": "string", + "examples": [ + "20.80.208.150" + ] + }, + "length": { + "description": "The length of the IP prefix.", + "type": "integer", + "examples": [ + 28 + ] + } + } + } + }, + "last_active_on": { + "description": "The time at which the runner was last used, in ISO 8601 format.", + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2022-10-09T23:39:01Z" ] } }, "required": [ - "name" + "id", + "name", + "image_details", + "machine_size_details", + "status", + "public_ip_enabled", + "platform" ] } } @@ -21635,63 +19370,56 @@ } ], "previews": [], - "descriptionHTML": "

Remove a custom label from a self-hosted runner configured\nin an enterprise. Returns the remaining labels from the runner.

\n

This endpoint returns a 404 Not Found status if the custom label is not\npresent on the runner.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" } - ] + ], + "descriptionHTML": "

Lists the GitHub-hosted runners in an organization group.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" }, { "serverUrl": "https://api.github.com", "verb": "get", - "requestPath": "/orgs/{org}/actions/runners", - "title": "List self-hosted runners for an organization", + "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories", + "title": "List repository access to a self-hosted runner group in an organization", "category": "actions", - "subcategory": "self-hosted-runners", + "subcategory": "self-hosted-runner-groups", "parameters": [ { - "name": "name", - "description": "

The name of a self-hosted runner.

", - "in": "query", + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, "schema": { "type": "string" } }, { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", + "name": "runner_group_id", + "description": "

Unique identifier of the self-hosted runner group.

", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" } }, { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "name": "page", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", - "default": 30 + "default": 1 } }, { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "name": "per_page", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", - "default": 1 + "default": 30 } } ], @@ -21713,7 +19441,8 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "org": "ORG" + "org": "ORG", + "runner_group_id": "RUNNER_GROUP_ID" } }, "response": { @@ -21721,82 +19450,1521 @@ "contentType": "application/json", "description": "

Response

", "example": { - "total_count": 2, - "runners": [ - { - "id": 23, - "name": "linux_runner", - "os": "linux", - "status": "online", - "busy": true, - "ephemeral": false, - "labels": [ - { - "id": 5, - "name": "self-hosted", - "type": "read-only" - }, - { - "id": 7, - "name": "X64", - "type": "read-only" - }, - { - "id": 11, - "name": "Linux", - "type": "read-only" - } - ] - }, + "total_count": 1, + "repositories": [ { - "id": 24, - "name": "mac_runner", - "os": "macos", - "status": "offline", - "busy": false, - "ephemeral": false, - "labels": [ - { - "id": 5, - "name": "self-hosted", - "type": "read-only" - }, - { - "id": 7, - "name": "X64", - "type": "read-only" - }, - { - "id": 20, - "name": "macOS", - "type": "read-only" - }, - { - "id": 21, - "name": "no-gpu", - "type": "custom" - } - ] - } - ] - }, - "schema": { - "type": "object", - "required": [ - "total_count", - "runners" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "runners": { - "type": "array", - "items": { - "title": "Self hosted runners", - "description": "A self hosted runner", - "type": "object", - "properties": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "template_repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "organization": null, + "language": null, + "forks": 9, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "watchers": 80, + "size": 108, + "default_branch": "master", + "open_issues": 0, + "open_issues_count": 0, + "is_template": true, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "allow_rebase_merge": true, + "template_repository": null, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "allow_auto_merge": false, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0 + }, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "delete_branch_on_merge": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + } + ] + }, + "schema": { + "type": "object", + "required": [ + "total_count", + "repositories" + ], + "properties": { + "total_count": { + "type": "number" + }, + "repositories": { + "type": "array", + "items": { + "title": "Minimal Repository", + "description": "Minimal Repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1296269 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "type": "string", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "has_discussions": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "role_name": { + "type": "string", + "examples": [ + "admin" + ] + }, + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "code_of_conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "contributor_covenant" + ] + }, + "name": { + "type": "string", + "examples": [ + "Contributor Covenant" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/codes_of_conduct/contributor_covenant" + ] + }, + "body": { + "type": "string", + "examples": [ + "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" + ] + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "key", + "name" + ] + }, + "license": { + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + } + }, + "forks": { + "type": "integer", + "examples": [ + 0 + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 0 + ] + }, + "watchers": { + "type": "integer", + "examples": [ + 0 + ] + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "security_and_analysis": { + "type": [ + "object", + "null" + ], + "properties": { + "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "code_security": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "dependabot_security_updates": { + "description": "Enable or disable Dependabot security updates for the repository.", + "type": "object", + "properties": { + "status": { + "description": "The enablement status of Dependabot security updates for the repository.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_push_protection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_non_provider_patterns": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_validity_checks": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + } + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" + ] + } + } + } + } + } + } + ], + "previews": [], + "descriptionHTML": "

Lists the repositories with access to a self-hosted runner group configured in an organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories", + "title": "Set repository access for a self-hosted runner group in an organization", + "category": "actions", + "subcategory": "self-hosted-runner-groups", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "runner_group_id", + "description": "

Unique identifier of the self-hosted runner group.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [ + { + "type": "array of integers", + "name": "selected_repository_ids", + "in": "body", + "description": "

List of repository IDs that can access the runner group.

", + "isRequired": true + } + ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Self-hosted runners\" organization permissions": "write" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "selected_repository_ids": [ + 32, + 91 + ] + }, + "parameters": { + "org": "ORG", + "runner_group_id": "RUNNER_GROUP_ID" + } + }, + "response": { + "statusCode": "204", + "description": "

Response

" + } + } + ], + "previews": [], + "descriptionHTML": "

Replaces the list of repositories that have access to a self-hosted runner group configured in an organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "

No Content

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}", + "title": "Add repository access to a self-hosted runner group in an organization", + "category": "actions", + "subcategory": "self-hosted-runner-groups", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "runner_group_id", + "description": "

Unique identifier of the self-hosted runner group.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "repository_id", + "description": "

The unique identifier of the repository.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Self-hosted runners\" organization permissions": "write", + "\"Metadata\" repository permissions": "read" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "runner_group_id": "RUNNER_GROUP_ID", + "repository_id": "REPOSITORY_ID" + } + }, + "response": { + "statusCode": "204", + "description": "

Response

" + } + } + ], + "previews": [], + "descriptionHTML": "

Adds a repository to the list of repositories that can access a self-hosted runner group. The runner group must have visibility set to selected. For more information, see \"Create a self-hosted runner group for an organization.\"

\n

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "

No Content

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "delete", + "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}", + "title": "Remove repository access to a self-hosted runner group in an organization", + "category": "actions", + "subcategory": "self-hosted-runner-groups", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "runner_group_id", + "description": "

Unique identifier of the self-hosted runner group.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "repository_id", + "description": "

The unique identifier of the repository.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Self-hosted runners\" organization permissions": "write", + "\"Metadata\" repository permissions": "read" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "runner_group_id": "RUNNER_GROUP_ID", + "repository_id": "REPOSITORY_ID" + } + }, + "response": { + "statusCode": "204", + "description": "

Response

" + } + } + ], + "previews": [], + "descriptionHTML": "

Removes a repository from the list of selected repositories that can access a self-hosted runner group. The runner group must have visibility set to selected. For more information, see \"Create a self-hosted runner group for an organization.\"

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "

No Content

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners", + "title": "List self-hosted runners in a group for an organization", + "category": "actions", + "subcategory": "self-hosted-runner-groups", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "runner_group_id", + "description": "

Unique identifier of the self-hosted runner group.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "per_page", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Self-hosted runners\" organization permissions": "read" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "runner_group_id": "RUNNER_GROUP_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "total_count": 2, + "runners": [ + { + "id": 23, + "name": "linux_runner", + "os": "linux", + "status": "online", + "busy": true, + "ephemeral": false, + "labels": [ + { + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 11, + "name": "Linux", + "type": "read-only" + } + ] + }, + { + "id": 24, + "name": "mac_runner", + "os": "macos", + "status": "offline", + "busy": false, + "ephemeral": false, + "labels": [ + { + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 20, + "name": "macOS", + "type": "read-only" + }, + { + "id": 21, + "name": "no-gpu", + "type": "custom" + } + ] + } + ] + }, + "schema": { + "type": "object", + "required": [ + "total_count", + "runners" + ], + "properties": { + "total_count": { + "type": "number" + }, + "runners": { + "type": "array", + "items": { + "title": "Self hosted runners", + "description": "A self hosted runner", + "type": "object", + "properties": { "id": { "description": "The ID of the runner.", "type": "integer", @@ -21884,7 +21052,7 @@ } ], "previews": [], - "descriptionHTML": "

Lists all self-hosted runners configured in an organization.

\n

Authenticated users must have admin access to the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

", + "descriptionHTML": "

Lists self-hosted runners that are in a specific organization group.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -21894,11 +21062,90 @@ }, { "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/orgs/{org}/actions/runners/downloads", - "title": "List runner applications for an organization", + "verb": "put", + "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners", + "title": "Set self-hosted runners in a group for an organization", "category": "actions", - "subcategory": "self-hosted-runners", + "subcategory": "self-hosted-runner-groups", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "runner_group_id", + "description": "

Unique identifier of the self-hosted runner group.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [ + { + "type": "array of integers", + "name": "runners", + "in": "body", + "description": "

List of runner IDs to add to the runner group.

", + "isRequired": true + } + ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Self-hosted runners\" organization permissions": "write" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "runners": [ + 9, + 2 + ] + }, + "parameters": { + "org": "ORG", + "runner_group_id": "RUNNER_GROUP_ID" + } + }, + "response": { + "statusCode": "204", + "description": "

Response

" + } + } + ], + "previews": [], + "descriptionHTML": "

Replaces the list of self-hosted runners that are part of an organization runner group.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "

No Content

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}", + "title": "Add a self-hosted runner to a group for an organization", + "category": "actions", + "subcategory": "self-hosted-runner-groups", "parameters": [ { "name": "org", @@ -21908,6 +21155,24 @@ "schema": { "type": "string" } + }, + { + "name": "runner_group_id", + "description": "

Unique identifier of the self-hosted runner group.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "runner_id", + "description": "

Unique identifier of the self-hosted runner.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], "bodyParameters": [], @@ -21917,7 +21182,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Self-hosted runners\" organization permissions": "read" + "\"Self-hosted runners\" organization permissions": "write" } ] }, @@ -21928,7 +21193,368 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "org": "ORG" + "org": "ORG", + "runner_group_id": "RUNNER_GROUP_ID", + "runner_id": "RUNNER_ID" + } + }, + "response": { + "statusCode": "204", + "description": "

Response

" + } + } + ], + "previews": [], + "descriptionHTML": "

Adds a self-hosted runner to a runner group configured in an organization.

\n

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "

No Content

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "delete", + "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}", + "title": "Remove a self-hosted runner from a group for an organization", + "category": "actions", + "subcategory": "self-hosted-runner-groups", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "runner_group_id", + "description": "

Unique identifier of the self-hosted runner group.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "runner_id", + "description": "

Unique identifier of the self-hosted runner.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Self-hosted runners\" organization permissions": "write" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "runner_group_id": "RUNNER_GROUP_ID", + "runner_id": "RUNNER_ID" + } + }, + "response": { + "statusCode": "204", + "description": "

Response

" + } + } + ], + "previews": [], + "descriptionHTML": "

Removes a self-hosted runner from a group configured in an organization. The runner is then returned to the default group.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "

No Content

" + } + ] + } + ], + "self-hosted-runners": [ + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/enterprises/{enterprise}/actions/runners", + "title": "List self-hosted runners for an enterprise", + "category": "actions", + "subcategory": "self-hosted-runners", + "parameters": [ + { + "name": "name", + "description": "

The name of a self-hosted runner.

", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "enterprise", + "description": "

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "enterprise": "ENTERPRISE" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "total_count": 2, + "runners": [ + { + "id": 23, + "name": "linux_runner", + "os": "linux", + "status": "online", + "busy": true, + "ephemeral": false, + "labels": [ + { + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 11, + "name": "Linux", + "type": "read-only" + } + ] + }, + { + "id": 24, + "name": "mac_runner", + "os": "macos", + "status": "offline", + "busy": false, + "ephemeral": false, + "labels": [ + { + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 20, + "name": "macOS", + "type": "read-only" + }, + { + "id": 21, + "name": "no-gpu", + "type": "custom" + } + ] + } + ] + }, + "schema": { + "type": "object", + "properties": { + "total_count": { + "type": "number" + }, + "runners": { + "type": "array", + "items": { + "title": "Self hosted runners", + "description": "A self hosted runner", + "type": "object", + "properties": { + "id": { + "description": "The ID of the runner.", + "type": "integer", + "examples": [ + 5 + ] + }, + "runner_group_id": { + "description": "The ID of the runner group.", + "type": "integer", + "examples": [ + 1 + ] + }, + "name": { + "description": "The name of the runner.", + "type": "string", + "examples": [ + "iMac" + ] + }, + "os": { + "description": "The Operating System of the runner.", + "type": "string", + "examples": [ + "macos" + ] + }, + "status": { + "description": "The status of the runner.", + "type": "string", + "examples": [ + "online" + ] + }, + "busy": { + "type": "boolean" + }, + "labels": { + "type": "array", + "items": { + "title": "Self hosted runner label", + "description": "A label for a self hosted runner", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier of the label." + }, + "name": { + "type": "string", + "description": "Name of the label." + }, + "type": { + "type": "string", + "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", + "enum": [ + "read-only", + "custom" + ] + } + }, + "required": [ + "name" + ] + } + }, + "ephemeral": { + "type": "boolean" + } + }, + "required": [ + "id", + "name", + "os", + "status", + "busy", + "labels" + ] + } + } + } + } + } + } + ], + "previews": [], + "descriptionHTML": "

Lists all self-hosted runners configured for an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/enterprises/{enterprise}/actions/runners/downloads", + "title": "List runner applications for an enterprise", + "category": "actions", + "subcategory": "self-hosted-runners", + "parameters": [ + { + "name": "enterprise", + "description": "

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "enterprise": "ENTERPRISE" } }, "response": { @@ -22006,7 +21632,7 @@ } ], "previews": [], - "descriptionHTML": "

Lists binaries for the runner application that you can download and run.

\n

Authenticated users must have admin access to the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

", + "descriptionHTML": "

Lists binaries for the runner application that you can download and run.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -22017,14 +21643,14 @@ { "serverUrl": "https://api.github.com", "verb": "post", - "requestPath": "/orgs/{org}/actions/runners/generate-jitconfig", - "title": "Create configuration for a just-in-time runner for an organization", + "requestPath": "/enterprises/{enterprise}/actions/runners/generate-jitconfig", + "title": "Create configuration for a just-in-time runner for an Enterprise", "category": "actions", "subcategory": "self-hosted-runners", "parameters": [ { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", + "name": "enterprise", + "description": "

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

", "in": "path", "required": true, "schema": { @@ -22063,14 +21689,10 @@ } ], "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Self-hosted runners\" organization permissions": "write" - } - ] + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] }, "codeExamples": [ { @@ -22091,7 +21713,7 @@ "work_folder": "_work" }, "parameters": { - "org": "ORG" + "enterprise": "ENTERPRISE" } }, "response": { @@ -22232,7 +21854,7 @@ } ], "previews": [], - "descriptionHTML": "

Generates a configuration that can be passed to the runner application at startup.

\n

The authenticated user must have admin access to the organization.

\n

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", + "descriptionHTML": "

Generates a configuration that can be passed to the runner application at startup.

\n

OAuth tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "201", @@ -22255,14 +21877,14 @@ { "serverUrl": "https://api.github.com", "verb": "post", - "requestPath": "/orgs/{org}/actions/runners/registration-token", - "title": "Create a registration token for an organization", + "requestPath": "/enterprises/{enterprise}/actions/runners/registration-token", + "title": "Create a registration token for an enterprise", "category": "actions", "subcategory": "self-hosted-runners", "parameters": [ { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", + "name": "enterprise", + "description": "

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

", "in": "path", "required": true, "schema": { @@ -22272,14 +21894,10 @@ ], "bodyParameters": [], "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Self-hosted runners\" organization permissions": "write" - } - ] + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] }, "codeExamples": [ { @@ -22288,7 +21906,7 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "org": "ORG" + "enterprise": "ENTERPRISE" } }, "response": { @@ -23308,7 +22926,7 @@ } ], "previews": [], - "descriptionHTML": "

Returns a token that you can pass to the config script. The token expires after one hour.

\n

For example, you can replace TOKEN in the following example with the registration token provided by this endpoint to configure your self-hosted runner:

\n
./config.sh --url https://github.com/octo-org --token TOKEN\n
\n

Authenticated users must have admin access to the organization to use this endpoint.

\n

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", + "descriptionHTML": "

Returns a token that you can pass to the config script. The token expires after one hour.

\n

Example using registration token:

\n

Configure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.

\n
./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n
\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "201", @@ -23319,14 +22937,14 @@ { "serverUrl": "https://api.github.com", "verb": "post", - "requestPath": "/orgs/{org}/actions/runners/remove-token", - "title": "Create a remove token for an organization", + "requestPath": "/enterprises/{enterprise}/actions/runners/remove-token", + "title": "Create a remove token for an enterprise", "category": "actions", "subcategory": "self-hosted-runners", "parameters": [ { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", + "name": "enterprise", + "description": "

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

", "in": "path", "required": true, "schema": { @@ -23336,14 +22954,10 @@ ], "bodyParameters": [], "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Self-hosted runners\" organization permissions": "write" - } - ] + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] }, "codeExamples": [ { @@ -23352,7 +22966,7 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "org": "ORG" + "enterprise": "ENTERPRISE" } }, "response": { @@ -24372,25 +23986,25 @@ } ], "previews": [], - "descriptionHTML": "

Returns a token that you can pass to the config script to remove a self-hosted runner from an organization. The token expires after one hour.

\n

For example, you can replace TOKEN in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization:

\n
./config.sh remove --token TOKEN\n
\n

Authenticated users must have admin access to the organization to use this endpoint.

\n

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "201", "description": "

Created

" } - ] + ], + "descriptionHTML": "

Returns a token that you can pass to the config script to remove a self-hosted runner from an enterprise. The token expires after one hour.

\n

Example using remove token:

\n

To remove your self-hosted runner from an enterprise, replace TOKEN with the remove token provided by this\nendpoint.

\n
./config.sh remove --token TOKEN\n
\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

" }, { "serverUrl": "https://api.github.com", "verb": "get", - "requestPath": "/orgs/{org}/actions/runners/{runner_id}", - "title": "Get a self-hosted runner for an organization", + "requestPath": "/enterprises/{enterprise}/actions/runners/{runner_id}", + "title": "Get a self-hosted runner for an enterprise", "category": "actions", "subcategory": "self-hosted-runners", "parameters": [ { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", + "name": "enterprise", + "description": "

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

", "in": "path", "required": true, "schema": { @@ -24409,14 +24023,10 @@ ], "bodyParameters": [], "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Self-hosted runners\" organization permissions": "read" - } - ] + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] }, "codeExamples": [ { @@ -24425,7 +24035,7 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "org": "ORG", + "enterprise": "ENTERPRISE", "runner_id": "RUNNER_ID" } }, @@ -24552,7 +24162,7 @@ } ], "previews": [], - "descriptionHTML": "

Gets a specific self-hosted runner configured in an organization.

\n

Authenticated users must have admin access to the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

", + "descriptionHTML": "

Gets a specific self-hosted runner configured in an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -24563,14 +24173,14 @@ { "serverUrl": "https://api.github.com", "verb": "delete", - "requestPath": "/orgs/{org}/actions/runners/{runner_id}", - "title": "Delete a self-hosted runner from an organization", + "requestPath": "/enterprises/{enterprise}/actions/runners/{runner_id}", + "title": "Delete a self-hosted runner from an enterprise", "category": "actions", "subcategory": "self-hosted-runners", "parameters": [ { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", + "name": "enterprise", + "description": "

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

", "in": "path", "required": true, "schema": { @@ -24589,14 +24199,10 @@ ], "bodyParameters": [], "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Self-hosted runners\" organization permissions": "write" - } - ] + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] }, "codeExamples": [ { @@ -24605,7 +24211,7 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "org": "ORG", + "enterprise": "ENTERPRISE", "runner_id": "RUNNER_ID" } }, @@ -24616,7 +24222,7 @@ } ], "previews": [], - "descriptionHTML": "

Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.

\n

Authenticated users must have admin access to the organization to use this endpoint.

\n

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", + "descriptionHTML": "

Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", @@ -24631,14 +24237,14 @@ { "serverUrl": "https://api.github.com", "verb": "get", - "requestPath": "/orgs/{org}/actions/runners/{runner_id}/labels", - "title": "List labels for a self-hosted runner for an organization", + "requestPath": "/enterprises/{enterprise}/actions/runners/{runner_id}/labels", + "title": "List labels for a self-hosted runner for an enterprise", "category": "actions", "subcategory": "self-hosted-runners", "parameters": [ { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", + "name": "enterprise", + "description": "

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

", "in": "path", "required": true, "schema": { @@ -24657,14 +24263,10 @@ ], "bodyParameters": [], "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Self-hosted runners\" organization permissions": "read" - } - ] + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] }, "codeExamples": [ { @@ -24673,7 +24275,7 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "org": "ORG", + "enterprise": "ENTERPRISE", "runner_id": "RUNNER_ID" } }, @@ -24751,7 +24353,7 @@ } ], "previews": [], - "descriptionHTML": "

Lists all labels for a self-hosted runner configured in an organization.

\n

Authenticated users must have admin access to the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

", + "descriptionHTML": "

Lists all labels for a self-hosted runner configured in an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -24766,14 +24368,14 @@ { "serverUrl": "https://api.github.com", "verb": "post", - "requestPath": "/orgs/{org}/actions/runners/{runner_id}/labels", - "title": "Add custom labels to a self-hosted runner for an organization", + "requestPath": "/enterprises/{enterprise}/actions/runners/{runner_id}/labels", + "title": "Add custom labels to a self-hosted runner for an enterprise", "category": "actions", "subcategory": "self-hosted-runners", "parameters": [ { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", + "name": "enterprise", + "description": "

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

", "in": "path", "required": true, "schema": { @@ -24800,14 +24402,10 @@ } ], "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Self-hosted runners\" organization permissions": "write" - } - ] + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] }, "codeExamples": [ { @@ -24823,7 +24421,7 @@ ] }, "parameters": { - "org": "ORG", + "enterprise": "ENTERPRISE", "runner_id": "RUNNER_ID" } }, @@ -24901,7 +24499,7 @@ } ], "previews": [], - "descriptionHTML": "

Adds custom labels to a self-hosted runner configured in an organization.

\n

Authenticated users must have admin access to the organization to use this endpoint.

\n

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", + "descriptionHTML": "

Add custom labels to a self-hosted runner configured in an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -24920,14 +24518,14 @@ { "serverUrl": "https://api.github.com", "verb": "put", - "requestPath": "/orgs/{org}/actions/runners/{runner_id}/labels", - "title": "Set custom labels for a self-hosted runner for an organization", + "requestPath": "/enterprises/{enterprise}/actions/runners/{runner_id}/labels", + "title": "Set custom labels for a self-hosted runner for an enterprise", "category": "actions", "subcategory": "self-hosted-runners", "parameters": [ { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", + "name": "enterprise", + "description": "

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

", "in": "path", "required": true, "schema": { @@ -24954,14 +24552,10 @@ } ], "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Self-hosted runners\" organization permissions": "write" - } - ] + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] }, "codeExamples": [ { @@ -24977,7 +24571,7 @@ ] }, "parameters": { - "org": "ORG", + "enterprise": "ENTERPRISE", "runner_id": "RUNNER_ID" } }, @@ -25055,7 +24649,7 @@ } ], "previews": [], - "descriptionHTML": "

Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in an organization.

\n

Authenticated users must have admin access to the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

", + "descriptionHTML": "

Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -25074,14 +24668,14 @@ { "serverUrl": "https://api.github.com", "verb": "delete", - "requestPath": "/orgs/{org}/actions/runners/{runner_id}/labels", - "title": "Remove all custom labels from a self-hosted runner for an organization", + "requestPath": "/enterprises/{enterprise}/actions/runners/{runner_id}/labels", + "title": "Remove all custom labels from a self-hosted runner for an enterprise", "category": "actions", "subcategory": "self-hosted-runners", "parameters": [ { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", + "name": "enterprise", + "description": "

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

", "in": "path", "required": true, "schema": { @@ -25100,14 +24694,10 @@ ], "bodyParameters": [], "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Self-hosted runners\" organization permissions": "write" - } - ] + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] }, "codeExamples": [ { @@ -25116,7 +24706,7 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "org": "ORG", + "enterprise": "ENTERPRISE", "runner_id": "RUNNER_ID" } }, @@ -25189,7 +24779,7 @@ } ], "previews": [], - "descriptionHTML": "

Remove all custom labels from a self-hosted runner configured in an\norganization. Returns the remaining read-only labels from the runner.

\n

Authenticated users must have admin access to the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

", + "descriptionHTML": "

Remove all custom labels from a self-hosted runner configured in an\nenterprise. Returns the remaining read-only labels from the runner.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -25198,20 +24788,24 @@ { "httpStatusCode": "404", "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", - "requestPath": "/orgs/{org}/actions/runners/{runner_id}/labels/{name}", - "title": "Remove a custom label from a self-hosted runner for an organization", + "requestPath": "/enterprises/{enterprise}/actions/runners/{runner_id}/labels/{name}", + "title": "Remove a custom label from a self-hosted runner for an enterprise", "category": "actions", "subcategory": "self-hosted-runners", "parameters": [ { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", + "name": "enterprise", + "description": "

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

", "in": "path", "required": true, "schema": { @@ -25239,14 +24833,10 @@ ], "bodyParameters": [], "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Self-hosted runners\" organization permissions": "write" - } - ] + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] }, "codeExamples": [ { @@ -25255,7 +24845,7 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "org": "ORG", + "enterprise": "ENTERPRISE", "runner_id": "RUNNER_ID", "name": "NAME" } @@ -25334,7 +24924,7 @@ } ], "previews": [], - "descriptionHTML": "

Remove a custom label from a self-hosted runner configured\nin an organization. Returns the remaining labels from the runner.

\n

This endpoint returns a 404 Not Found status if the custom label is not\npresent on the runner.

\n

Authenticated users must have admin access to the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

", + "descriptionHTML": "

Remove a custom label from a self-hosted runner configured\nin an enterprise. Returns the remaining labels from the runner.

\n

This endpoint returns a 404 Not Found status if the custom label is not\npresent on the runner.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -25353,8 +24943,8 @@ { "serverUrl": "https://api.github.com", "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runners", - "title": "List self-hosted runners for a repository", + "requestPath": "/orgs/{org}/actions/runners", + "title": "List self-hosted runners for an organization", "category": "actions", "subcategory": "self-hosted-runners", "parameters": [ @@ -25367,17 +24957,8 @@ } }, { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", "in": "path", "required": true, "schema": { @@ -25410,7 +24991,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Administration\" repository permissions": "read" + "\"Self-hosted runners\" organization permissions": "read" } ] }, @@ -25421,8 +25002,7 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "owner": "OWNER", - "repo": "REPO" + "org": "ORG" } }, "response": { @@ -25593,7 +25173,7 @@ } ], "previews": [], - "descriptionHTML": "

Lists all self-hosted runners configured in a repository.

\n

Authenticated users must have admin access to the repository to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", + "descriptionHTML": "

Lists all self-hosted runners configured in an organization.

\n

Authenticated users must have admin access to the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

", "statusCodes": [ { "httpStatusCode": "200", @@ -25604,23 +25184,14 @@ { "serverUrl": "https://api.github.com", "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runners/downloads", - "title": "List runner applications for a repository", + "requestPath": "/orgs/{org}/actions/runners/downloads", + "title": "List runner applications for an organization", "category": "actions", "subcategory": "self-hosted-runners", "parameters": [ { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", "in": "path", "required": true, "schema": { @@ -25635,7 +25206,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Administration\" repository permissions": "read" + "\"Self-hosted runners\" organization permissions": "read" } ] }, @@ -25646,8 +25217,7 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "owner": "OWNER", - "repo": "REPO" + "org": "ORG" } }, "response": { @@ -25725,7 +25295,7 @@ } ], "previews": [], - "descriptionHTML": "

Lists binaries for the runner application that you can download and run.

\n

Authenticated users must have admin access to the repository to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", + "descriptionHTML": "

Lists binaries for the runner application that you can download and run.

\n

Authenticated users must have admin access to the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

", "statusCodes": [ { "httpStatusCode": "200", @@ -25736,23 +25306,14 @@ { "serverUrl": "https://api.github.com", "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runners/generate-jitconfig", - "title": "Create configuration for a just-in-time runner for a repository", + "requestPath": "/orgs/{org}/actions/runners/generate-jitconfig", + "title": "Create configuration for a just-in-time runner for an organization", "category": "actions", "subcategory": "self-hosted-runners", "parameters": [ { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", "in": "path", "required": true, "schema": { @@ -25796,7 +25357,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Administration\" repository permissions": "write" + "\"Self-hosted runners\" organization permissions": "write" } ] }, @@ -25819,8 +25380,7 @@ "work_folder": "_work" }, "parameters": { - "owner": "OWNER", - "repo": "REPO" + "org": "ORG" } }, "response": { @@ -25961,7 +25521,7 @@ } ], "previews": [], - "descriptionHTML": "

Generates a configuration that can be passed to the runner application at startup.

\n

The authenticated user must have admin access to the repository.

\n

OAuth tokens and personal access tokens (classic) need therepo scope to use this endpoint.

", + "descriptionHTML": "

Generates a configuration that can be passed to the runner application at startup.

\n

The authenticated user must have admin access to the organization.

\n

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "201", @@ -25984,23 +25544,14 @@ { "serverUrl": "https://api.github.com", "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runners/registration-token", - "title": "Create a registration token for a repository", + "requestPath": "/orgs/{org}/actions/runners/registration-token", + "title": "Create a registration token for an organization", "category": "actions", "subcategory": "self-hosted-runners", "parameters": [ { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", "in": "path", "required": true, "schema": { @@ -26015,7 +25566,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Administration\" repository permissions": "write" + "\"Self-hosted runners\" organization permissions": "write" } ] }, @@ -26026,8 +25577,7 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "owner": "OWNER", - "repo": "REPO" + "org": "ORG" } }, "response": { @@ -27047,7 +26597,7 @@ } ], "previews": [], - "descriptionHTML": "

Returns a token that you can pass to the config script. The token expires after one hour.

\n

For example, you can replace TOKEN in the following example with the registration token provided by this endpoint to configure your self-hosted runner:

\n
./config.sh --url https://github.com/octo-org --token TOKEN\n
\n

Authenticated users must have admin access to the repository to use this endpoint.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", + "descriptionHTML": "

Returns a token that you can pass to the config script. The token expires after one hour.

\n

For example, you can replace TOKEN in the following example with the registration token provided by this endpoint to configure your self-hosted runner:

\n
./config.sh --url https://github.com/octo-org --token TOKEN\n
\n

Authenticated users must have admin access to the organization to use this endpoint.

\n

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "201", @@ -27058,23 +26608,14 @@ { "serverUrl": "https://api.github.com", "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runners/remove-token", - "title": "Create a remove token for a repository", + "requestPath": "/orgs/{org}/actions/runners/remove-token", + "title": "Create a remove token for an organization", "category": "actions", "subcategory": "self-hosted-runners", "parameters": [ { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", "in": "path", "required": true, "schema": { @@ -27089,7 +26630,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Administration\" repository permissions": "write" + "\"Self-hosted runners\" organization permissions": "write" } ] }, @@ -27100,8 +26641,7 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "owner": "OWNER", - "repo": "REPO" + "org": "ORG" } }, "response": { @@ -28121,7 +27661,7 @@ } ], "previews": [], - "descriptionHTML": "

Returns a token that you can pass to the config script to remove a self-hosted runner from an repository. The token expires after one hour.

\n

For example, you can replace TOKEN in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization:

\n
./config.sh remove --token TOKEN\n
\n

Authenticated users must have admin access to the repository to use this endpoint.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", + "descriptionHTML": "

Returns a token that you can pass to the config script to remove a self-hosted runner from an organization. The token expires after one hour.

\n

For example, you can replace TOKEN in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization:

\n
./config.sh remove --token TOKEN\n
\n

Authenticated users must have admin access to the organization to use this endpoint.

\n

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "201", @@ -28132,23 +27672,14 @@ { "serverUrl": "https://api.github.com", "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runners/{runner_id}", - "title": "Get a self-hosted runner for a repository", + "requestPath": "/orgs/{org}/actions/runners/{runner_id}", + "title": "Get a self-hosted runner for an organization", "category": "actions", "subcategory": "self-hosted-runners", "parameters": [ { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", "in": "path", "required": true, "schema": { @@ -28172,7 +27703,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Administration\" repository permissions": "read" + "\"Self-hosted runners\" organization permissions": "read" } ] }, @@ -28183,8 +27714,7 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "owner": "OWNER", - "repo": "REPO", + "org": "ORG", "runner_id": "RUNNER_ID" } }, @@ -28311,7 +27841,7 @@ } ], "previews": [], - "descriptionHTML": "

Gets a specific self-hosted runner configured in a repository.

\n

Authenticated users must have admin access to the repository to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", + "descriptionHTML": "

Gets a specific self-hosted runner configured in an organization.

\n

Authenticated users must have admin access to the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

", "statusCodes": [ { "httpStatusCode": "200", @@ -28322,23 +27852,14 @@ { "serverUrl": "https://api.github.com", "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/actions/runners/{runner_id}", - "title": "Delete a self-hosted runner from a repository", + "requestPath": "/orgs/{org}/actions/runners/{runner_id}", + "title": "Delete a self-hosted runner from an organization", "category": "actions", "subcategory": "self-hosted-runners", "parameters": [ { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", "in": "path", "required": true, "schema": { @@ -28362,7 +27883,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Administration\" repository permissions": "write" + "\"Self-hosted runners\" organization permissions": "write" } ] }, @@ -28373,8 +27894,7 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "owner": "OWNER", - "repo": "REPO", + "org": "ORG", "runner_id": "RUNNER_ID" } }, @@ -28385,7 +27905,7 @@ } ], "previews": [], - "descriptionHTML": "

Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.

\n

Authenticated users must have admin access to the repository to use this endpoint.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", + "descriptionHTML": "

Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.

\n

Authenticated users must have admin access to the organization to use this endpoint.

\n

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", @@ -28400,23 +27920,14 @@ { "serverUrl": "https://api.github.com", "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels", - "title": "List labels for a self-hosted runner for a repository", + "requestPath": "/orgs/{org}/actions/runners/{runner_id}/labels", + "title": "List labels for a self-hosted runner for an organization", "category": "actions", "subcategory": "self-hosted-runners", "parameters": [ { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", "in": "path", "required": true, "schema": { @@ -28440,7 +27951,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Administration\" repository permissions": "read" + "\"Self-hosted runners\" organization permissions": "read" } ] }, @@ -28451,8 +27962,7 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "owner": "OWNER", - "repo": "REPO", + "org": "ORG", "runner_id": "RUNNER_ID" } }, @@ -28530,7 +28040,7 @@ } ], "previews": [], - "descriptionHTML": "

Lists all labels for a self-hosted runner configured in a repository.

\n

Authenticated users must have admin access to the repository to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", + "descriptionHTML": "

Lists all labels for a self-hosted runner configured in an organization.

\n

Authenticated users must have admin access to the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

", "statusCodes": [ { "httpStatusCode": "200", @@ -28545,14 +28055,14 @@ { "serverUrl": "https://api.github.com", "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels", - "title": "Add custom labels to a self-hosted runner for a repository", + "requestPath": "/orgs/{org}/actions/runners/{runner_id}/labels", + "title": "Add custom labels to a self-hosted runner for an organization", "category": "actions", "subcategory": "self-hosted-runners", "parameters": [ { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", "in": "path", "required": true, "schema": { @@ -28560,8 +28070,153 @@ } }, { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", + "name": "runner_id", + "description": "

Unique identifier of the self-hosted runner.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [ + { + "type": "array of strings", + "name": "labels", + "in": "body", + "description": "

The names of the custom labels to add to the runner.

", + "isRequired": true + } + ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Self-hosted runners\" organization permissions": "write" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "labels": [ + "gpu", + "accelerated" + ] + }, + "parameters": { + "org": "ORG", + "runner_id": "RUNNER_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "total_count": 4, + "labels": [ + { + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 20, + "name": "macOS", + "type": "read-only" + }, + { + "id": 21, + "name": "no-gpu", + "type": "custom" + } + ] + }, + "schema": { + "type": "object", + "required": [ + "total_count", + "labels" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "labels": { + "type": "array", + "items": { + "title": "Self hosted runner label", + "description": "A label for a self hosted runner", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier of the label." + }, + "name": { + "type": "string", + "description": "Name of the label." + }, + "type": { + "type": "string", + "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", + "enum": [ + "read-only", + "custom" + ] + } + }, + "required": [ + "name" + ] + } + } + } + } + } + } + ], + "previews": [], + "descriptionHTML": "

Adds custom labels to a self-hosted runner configured in an organization.

\n

Authenticated users must have admin access to the organization to use this endpoint.

\n

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/orgs/{org}/actions/runners/{runner_id}/labels", + "title": "Set custom labels for a self-hosted runner for an organization", + "category": "actions", + "subcategory": "self-hosted-runners", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", "in": "path", "required": true, "schema": { @@ -28583,7 +28238,7 @@ "type": "array of strings", "name": "labels", "in": "body", - "description": "

The names of the custom labels to add to the runner.

", + "description": "

The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.

", "isRequired": true } ], @@ -28593,7 +28248,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Administration\" repository permissions": "write" + "\"Self-hosted runners\" organization permissions": "write" } ] }, @@ -28611,8 +28266,7 @@ ] }, "parameters": { - "owner": "OWNER", - "repo": "REPO", + "org": "ORG", "runner_id": "RUNNER_ID" } }, @@ -28690,171 +28344,7 @@ } ], "previews": [], - "descriptionHTML": "

Adds custom labels to a self-hosted runner configured in a repository.

\n

Authenticated users must have admin access to the organization to use this endpoint.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels", - "title": "Set custom labels for a self-hosted runner for a repository", - "category": "actions", - "subcategory": "self-hosted-runners", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "runner_id", - "description": "

Unique identifier of the self-hosted runner.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "array of strings", - "name": "labels", - "in": "body", - "description": "

The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.

", - "isRequired": true - } - ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "write" - } - ] - }, - "codeExamples": [ - { - "key": "default", - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "labels": [ - "gpu", - "accelerated" - ] - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "runner_id": "RUNNER_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "total_count": 4, - "labels": [ - { - "id": 5, - "name": "self-hosted", - "type": "read-only" - }, - { - "id": 7, - "name": "X64", - "type": "read-only" - }, - { - "id": 20, - "name": "macOS", - "type": "read-only" - }, - { - "id": 21, - "name": "no-gpu", - "type": "custom" - } - ] - }, - "schema": { - "type": "object", - "required": [ - "total_count", - "labels" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "labels": { - "type": "array", - "items": { - "title": "Self hosted runner label", - "description": "A label for a self hosted runner", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "Unique identifier of the label." - }, - "name": { - "type": "string", - "description": "Name of the label." - }, - "type": { - "type": "string", - "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", - "enum": [ - "read-only", - "custom" - ] - } - }, - "required": [ - "name" - ] - } - } - } - } - } - } - ], - "previews": [], - "descriptionHTML": "

Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in a repository.

\n

Authenticated users must have admin access to the repository to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", + "descriptionHTML": "

Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in an organization.

\n

Authenticated users must have admin access to the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

", "statusCodes": [ { "httpStatusCode": "200", @@ -28873,23 +28363,14 @@ { "serverUrl": "https://api.github.com", "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels", - "title": "Remove all custom labels from a self-hosted runner for a repository", + "requestPath": "/orgs/{org}/actions/runners/{runner_id}/labels", + "title": "Remove all custom labels from a self-hosted runner for an organization", "category": "actions", "subcategory": "self-hosted-runners", "parameters": [ { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", "in": "path", "required": true, "schema": { @@ -28913,7 +28394,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Administration\" repository permissions": "write" + "\"Self-hosted runners\" organization permissions": "write" } ] }, @@ -28924,8 +28405,7 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "owner": "OWNER", - "repo": "REPO", + "org": "ORG", "runner_id": "RUNNER_ID" } }, @@ -28998,7 +28478,7 @@ } ], "previews": [], - "descriptionHTML": "

Remove all custom labels from a self-hosted runner configured in a\nrepository. Returns the remaining read-only labels from the runner.

\n

Authenticated users must have admin access to the repository to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", + "descriptionHTML": "

Remove all custom labels from a self-hosted runner configured in an\norganization. Returns the remaining read-only labels from the runner.

\n

Authenticated users must have admin access to the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

", "statusCodes": [ { "httpStatusCode": "200", @@ -29013,23 +28493,14 @@ { "serverUrl": "https://api.github.com", "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels/{name}", - "title": "Remove a custom label from a self-hosted runner for a repository", + "requestPath": "/orgs/{org}/actions/runners/{runner_id}/labels/{name}", + "title": "Remove a custom label from a self-hosted runner for an organization", "category": "actions", "subcategory": "self-hosted-runners", "parameters": [ { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", "in": "path", "required": true, "schema": { @@ -29062,7 +28533,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Administration\" repository permissions": "write" + "\"Self-hosted runners\" organization permissions": "write" } ] }, @@ -29073,8 +28544,7 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "owner": "OWNER", - "repo": "REPO", + "org": "ORG", "runner_id": "RUNNER_ID", "name": "NAME" } @@ -29153,7 +28623,7 @@ } ], "previews": [], - "descriptionHTML": "

Remove a custom label from a self-hosted runner configured\nin a repository. Returns the remaining labels from the runner.

\n

This endpoint returns a 404 Not Found status if the custom label is not\npresent on the runner.

\n

Authenticated users must have admin access to the repository to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", + "descriptionHTML": "

Remove a custom label from a self-hosted runner configured\nin an organization. Returns the remaining labels from the runner.

\n

This endpoint returns a 404 Not Found status if the custom label is not\npresent on the runner.

\n

Authenticated users must have admin access to the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

", "statusCodes": [ { "httpStatusCode": "200", @@ -29168,20 +28638,35 @@ "description": "

Validation failed, or the endpoint has been spammed.

" } ] - } - ], - "variables": [ + }, { "serverUrl": "https://api.github.com", "verb": "get", - "requestPath": "/orgs/{org}/actions/variables", - "title": "List organization variables", + "requestPath": "/repos/{owner}/{repo}/actions/runners", + "title": "List self-hosted runners for a repository", "category": "actions", - "subcategory": "variables", + "subcategory": "self-hosted-runners", "parameters": [ { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", + "name": "name", + "description": "

The name of a self-hosted runner.

", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", "in": "path", "required": true, "schema": { @@ -29190,11 +28675,11 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 30). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", - "default": 10 + "default": 30 } }, { @@ -29214,7 +28699,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Variables\" organization permissions": "read" + "\"Administration\" repository permissions": "read" } ] }, @@ -29225,7 +28710,8 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "org": "ORG" + "owner": "OWNER", + "repo": "REPO" } }, "response": { @@ -29233,29 +28719,62 @@ "contentType": "application/json", "description": "

Response

", "example": { - "total_count": 3, - "variables": [ - { - "name": "USERNAME", - "value": "octocat", - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z", - "visibility": "private" - }, + "total_count": 2, + "runners": [ { - "name": "ACTIONS_RUNNER_DEBUG", - "value": true, - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z", - "visibility": "all" + "id": 23, + "name": "linux_runner", + "os": "linux", + "status": "online", + "busy": true, + "ephemeral": false, + "labels": [ + { + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 11, + "name": "Linux", + "type": "read-only" + } + ] }, { - "name": "ADMIN_EMAIL", - "value": "octocat@github.com", - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z", - "visibility": "selected", - "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/variables/ADMIN_EMAIL/repositories" + "id": 24, + "name": "mac_runner", + "os": "macos", + "status": "offline", + "busy": false, + "ephemeral": false, + "labels": [ + { + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 20, + "name": "macOS", + "type": "read-only" + }, + { + "id": 21, + "name": "no-gpu", + "type": "custom" + } + ] } ] }, @@ -29263,72 +28782,97 @@ "type": "object", "required": [ "total_count", - "variables" + "runners" ], "properties": { "total_count": { "type": "integer" }, - "variables": { + "runners": { "type": "array", "items": { - "title": "Actions Variable for an Organization", - "description": "Organization variable for GitHub Actions.", + "title": "Self hosted runners", + "description": "A self hosted runner", "type": "object", "properties": { - "name": { - "description": "The name of the variable.", - "type": "string", + "id": { + "description": "The ID of the runner.", + "type": "integer", "examples": [ - "USERNAME" + 5 ] }, - "value": { - "description": "The value of the variable.", - "type": "string", + "runner_group_id": { + "description": "The ID of the runner group.", + "type": "integer", "examples": [ - "octocat" + 1 ] }, - "created_at": { - "description": "The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "name": { + "description": "The name of the runner.", "type": "string", - "format": "date-time", "examples": [ - "2019-01-24T22:45:36.000Z" + "iMac" ] }, - "updated_at": { - "description": "The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "os": { + "description": "The Operating System of the runner.", "type": "string", - "format": "date-time", "examples": [ - "2019-01-24T22:45:36.000Z" + "macos" ] }, - "visibility": { - "description": "Visibility of a variable", - "enum": [ - "all", - "private", - "selected" - ], - "type": "string" - }, - "selected_repositories_url": { + "status": { + "description": "The status of the runner.", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/organizations/org/variables/USERNAME/repositories" + "online" ] + }, + "busy": { + "type": "boolean" + }, + "labels": { + "type": "array", + "items": { + "title": "Self hosted runner label", + "description": "A label for a self hosted runner", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier of the label." + }, + "name": { + "type": "string", + "description": "Name of the label." + }, + "type": { + "type": "string", + "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", + "enum": [ + "read-only", + "custom" + ] + } + }, + "required": [ + "name" + ] + } + }, + "ephemeral": { + "type": "boolean" } }, "required": [ + "id", "name", - "value", - "created_at", - "updated_at", - "visibility" + "os", + "status", + "busy", + "labels" ] } } @@ -29338,7 +28882,7 @@ } ], "previews": [], - "descriptionHTML": "

Lists all organization variables.

\n

Authenticated users must have collaborator access to a repository to create, update, or read variables.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

", + "descriptionHTML": "

Lists all self-hosted runners configured in a repository.

\n

Authenticated users must have admin access to the repository to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -29346,123 +28890,17 @@ } ] }, - { - "serverUrl": "https://api.github.com", - "verb": "post", - "requestPath": "/orgs/{org}/actions/variables", - "title": "Create an organization variable", - "category": "actions", - "subcategory": "variables", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "name", - "in": "body", - "description": "

The name of the variable.

", - "isRequired": true - }, - { - "type": "string", - "name": "value", - "in": "body", - "description": "

The value of the variable.

", - "isRequired": true - }, - { - "type": "string", - "name": "visibility", - "in": "body", - "description": "

The type of repositories in the organization that can access the variable. selected means only the repositories specified by selected_repository_ids can access the variable.

", - "isRequired": true, - "enum": [ - "all", - "private", - "selected" - ] - }, - { - "type": "array of integers", - "name": "selected_repository_ids", - "in": "body", - "description": "

An array of repository ids that can access the organization variable. You can only provide a list of repository ids when the visibility is set to selected.

" - } - ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Variables\" organization permissions": "write" - } - ] - }, - "codeExamples": [ - { - "key": "default", - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "name": "USERNAME", - "value": "octocat", - "visibility": "selected", - "selected_repository_ids": [ - 1296269, - 1296280 - ] - }, - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response when creating a variable

", - "example": null, - "schema": { - "title": "Empty Object", - "description": "An object without any properties.", - "type": "object", - "properties": {}, - "additionalProperties": false - } - } - } - ], - "previews": [], - "descriptionHTML": "

Creates an organization variable that you can reference in a GitHub Actions workflow.

\n

Authenticated users must have collaborator access to a repository to create, update, or read variables.

\n

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Response when creating a variable

" - } - ] - }, { "serverUrl": "https://api.github.com", "verb": "get", - "requestPath": "/orgs/{org}/actions/variables/{name}", - "title": "Get an organization variable", + "requestPath": "/repos/{owner}/{repo}/actions/runners/downloads", + "title": "List runner applications for a repository", "category": "actions", - "subcategory": "variables", + "subcategory": "self-hosted-runners", "parameters": [ { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", "in": "path", "required": true, "schema": { @@ -29470,8 +28908,8 @@ } }, { - "name": "name", - "description": "

The name of the variable.

", + "name": "repo", + "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", "in": "path", "required": true, "schema": { @@ -29486,7 +28924,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Variables\" organization permissions": "read" + "\"Administration\" repository permissions": "read" } ] }, @@ -29497,87 +28935,86 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "org": "ORG", - "name": "NAME" + "owner": "OWNER", + "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "

Response

", - "example": { - "name": "USERNAME", - "value": "octocat", - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z", - "visibility": "selected", - "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/variables/USERNAME/repositories" - }, + "example": [ + { + "os": "osx", + "architecture": "x64", + "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-osx-x64-2.164.0.tar.gz", + "filename": "actions-runner-osx-x64-2.164.0.tar.gz" + }, + { + "os": "linux", + "architecture": "x64", + "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-x64-2.164.0.tar.gz", + "filename": "actions-runner-linux-x64-2.164.0.tar.gz" + }, + { + "os": "linux", + "architecture": "arm", + "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-arm-2.164.0.tar.gz", + "filename": "actions-runner-linux-arm-2.164.0.tar.gz" + }, + { + "os": "win", + "architecture": "x64", + "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-win-x64-2.164.0.zip", + "filename": "actions-runner-win-x64-2.164.0.zip" + }, + { + "os": "linux", + "architecture": "arm64", + "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-arm64-2.164.0.tar.gz", + "filename": "actions-runner-linux-arm64-2.164.0.tar.gz" + } + ], "schema": { - "title": "Actions Variable for an Organization", - "description": "Organization variable for GitHub Actions.", - "type": "object", - "properties": { - "name": { - "description": "The name of the variable.", - "type": "string", - "examples": [ - "USERNAME" - ] - }, - "value": { - "description": "The value of the variable.", - "type": "string", - "examples": [ - "octocat" - ] - }, - "created_at": { - "description": "The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "type": "string", - "format": "date-time", - "examples": [ - "2019-01-24T22:45:36.000Z" - ] - }, - "updated_at": { - "description": "The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "type": "string", - "format": "date-time", - "examples": [ - "2019-01-24T22:45:36.000Z" - ] - }, - "visibility": { - "description": "Visibility of a variable", - "enum": [ - "all", - "private", - "selected" - ], - "type": "string" + "type": "array", + "items": { + "title": "Runner Application", + "description": "Runner Application", + "type": "object", + "properties": { + "os": { + "type": "string" + }, + "architecture": { + "type": "string" + }, + "download_url": { + "type": "string" + }, + "filename": { + "type": "string" + }, + "temp_download_token": { + "description": "A short lived bearer token used to download the runner, if needed.", + "type": "string" + }, + "sha256_checksum": { + "type": "string" + } }, - "selected_repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/org/variables/USERNAME/repositories" - ] - } - }, - "required": [ - "name", - "value", - "created_at", - "updated_at", - "visibility" - ] + "required": [ + "os", + "architecture", + "download_url", + "filename" + ] + } } } } ], "previews": [], - "descriptionHTML": "

Gets a specific variable in an organization.

\n

The authenticated user must have collaborator access to a repository to create, update, or read variables.

\n

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", + "descriptionHTML": "

Lists binaries for the runner application that you can download and run.

\n

Authenticated users must have admin access to the repository to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -29587,15 +29024,15 @@ }, { "serverUrl": "https://api.github.com", - "verb": "patch", - "requestPath": "/orgs/{org}/actions/variables/{name}", - "title": "Update an organization variable", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/actions/runners/generate-jitconfig", + "title": "Create configuration for a just-in-time runner for a repository", "category": "actions", - "subcategory": "variables", + "subcategory": "self-hosted-runners", "parameters": [ { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", "in": "path", "required": true, "schema": { @@ -29603,8 +29040,8 @@ } }, { - "name": "name", - "description": "

The name of the variable.

", + "name": "repo", + "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", "in": "path", "required": true, "schema": { @@ -29617,30 +29054,29 @@ "type": "string", "name": "name", "in": "body", - "description": "

The name of the variable.

" + "description": "

The name of the new runner.

", + "isRequired": true }, { - "type": "string", - "name": "value", + "type": "integer", + "name": "runner_group_id", "in": "body", - "description": "

The value of the variable.

" + "description": "

The ID of the runner group to register the runner to.

", + "isRequired": true }, { - "type": "string", - "name": "visibility", + "type": "array of strings", + "name": "labels", "in": "body", - "description": "

The type of repositories in the organization that can access the variable. selected means only the repositories specified by selected_repository_ids can access the variable.

", - "enum": [ - "all", - "private", - "selected" - ] + "description": "

The names of the custom labels to add to the runner. Minimum items: 1. Maximum items: 100.

", + "isRequired": true }, { - "type": "array of integers", - "name": "selected_repository_ids", + "type": "string", + "name": "work_folder", "in": "body", - "description": "

An array of repository ids that can access the organization variable. You can only provide a list of repository ids when the visibility is set to selected.

" + "description": "

The working directory to be used for job execution, relative to the runner install directory.

", + "default": "_work" } ], "progAccess": { @@ -29649,7 +29085,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Variables\" organization permissions": "write" + "\"Administration\" repository permissions": "write" } ] }, @@ -29661,109 +29097,190 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "name": "USERNAME", - "value": "octocat", - "visibility": "selected", - "selected_repository_ids": [ - 1296269, - 1296280 - ] + "name": "New runner", + "runner_group_id": 1, + "labels": [ + "self-hosted", + "X64", + "macOS", + "no-gpu" + ], + "work_folder": "_work" }, "parameters": { - "org": "ORG", - "name": "NAME" + "owner": "OWNER", + "repo": "REPO" } }, "response": { - "statusCode": "204", - "description": "

Response

" + "statusCode": "201", + "contentType": "application/json", + "description": "

Response

", + "example": { + "runner": { + "id": 23, + "name": "New runner", + "os": "unknown", + "status": "offline", + "busy": false, + "labels": [ + { + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 20, + "name": "macOS", + "type": "read-only" + }, + { + "id": 21, + "name": "no-gpu", + "type": "custom" + } + ] + }, + "encoded_jit_config": "abc123" + }, + "schema": { + "type": "object", + "required": [ + "runner", + "encoded_jit_config" + ], + "properties": { + "runner": { + "title": "Self hosted runners", + "description": "A self hosted runner", + "type": "object", + "properties": { + "id": { + "description": "The ID of the runner.", + "type": "integer", + "examples": [ + 5 + ] + }, + "runner_group_id": { + "description": "The ID of the runner group.", + "type": "integer", + "examples": [ + 1 + ] + }, + "name": { + "description": "The name of the runner.", + "type": "string", + "examples": [ + "iMac" + ] + }, + "os": { + "description": "The Operating System of the runner.", + "type": "string", + "examples": [ + "macos" + ] + }, + "status": { + "description": "The status of the runner.", + "type": "string", + "examples": [ + "online" + ] + }, + "busy": { + "type": "boolean" + }, + "labels": { + "type": "array", + "items": { + "title": "Self hosted runner label", + "description": "A label for a self hosted runner", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier of the label." + }, + "name": { + "type": "string", + "description": "Name of the label." + }, + "type": { + "type": "string", + "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", + "enum": [ + "read-only", + "custom" + ] + } + }, + "required": [ + "name" + ] + } + }, + "ephemeral": { + "type": "boolean" + } + }, + "required": [ + "id", + "name", + "os", + "status", + "busy", + "labels" + ] + }, + "encoded_jit_config": { + "type": "string", + "description": "The base64 encoded runner configuration." + } + } + } } } ], "previews": [], - "descriptionHTML": "

Updates an organization variable that you can reference in a GitHub Actions workflow.

\n

Authenticated users must have collaborator access to a repository to create, update, or read variables.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

", + "descriptionHTML": "

Generates a configuration that can be passed to the runner application at startup.

\n

The authenticated user must have admin access to the repository.

\n

OAuth tokens and personal access tokens (classic) need therepo scope to use this endpoint.

", "statusCodes": [ { - "httpStatusCode": "204", - "description": "

No Content

" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/variables/{name}", - "title": "Delete an organization variable", - "category": "actions", - "subcategory": "variables", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } + "httpStatusCode": "201", + "description": "

Created

" }, { - "name": "name", - "description": "

The name of the variable.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Variables\" organization permissions": "write" - } - ] - }, - "codeExamples": [ + "httpStatusCode": "404", + "description": "

Resource not found

" + }, { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "name": "NAME" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "previews": [], - "descriptionHTML": "

Deletes an organization variable using the variable name.

\n

Authenticated users must have collaborator access to a repository to create, update, or read variables.

\n

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "statusCodes": [ + "httpStatusCode": "409", + "description": "

Conflict

" + }, { - "httpStatusCode": "204", - "description": "

No Content

" + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" } ] }, { "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/orgs/{org}/actions/variables/{name}/repositories", - "title": "List selected repositories for an organization variable", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/actions/runners/registration-token", + "title": "Create a registration token for a repository", "category": "actions", - "subcategory": "variables", + "subcategory": "self-hosted-runners", "parameters": [ { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", "in": "path", "required": true, "schema": { @@ -29771,31 +29288,13 @@ } }, { - "name": "name", - "description": "

The name of the variable.

", + "name": "repo", + "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", "in": "path", "required": true, "schema": { "type": "string" } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } } ], "bodyParameters": [], @@ -29805,7 +29304,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Variables\" organization permissions": "read" + "\"Administration\" repository permissions": "write" } ] }, @@ -29816,110 +29315,61 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "org": "ORG", - "name": "NAME" + "owner": "OWNER", + "repo": "REPO" } }, "response": { - "statusCode": "200", + "statusCode": "201", "contentType": "application/json", "description": "

Response

", "example": { - "total_count": 1, - "repositories": [ - { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "owner": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World", - "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" - } - ] + "token": "LLBF3JGZDX3P5PMEXLND6TS6FCWO6", + "expires_at": "2020-01-22T12:13:35.123-08:00" }, "schema": { + "title": "Authentication Token", + "description": "Authentication Token", "type": "object", - "required": [ - "total_count", - "repositories" - ], "properties": { - "total_count": { - "type": "integer" + "token": { + "description": "The token used for authentication", + "type": "string", + "examples": [ + "v1.1f699f1069f60xxx" + ] + }, + "expires_at": { + "description": "The time this token expires", + "type": "string", + "format": "date-time", + "examples": [ + "2016-07-11T22:14:10Z" + ] + }, + "permissions": { + "type": "object", + "examples": [ + { + "issues": "read", + "deployments": "write" + } + ] }, "repositories": { + "description": "The repositories this token has access to", "type": "array", "items": { - "title": "Minimal Repository", - "description": "Minimal Repository", + "title": "Repository", + "description": "A repository on GitHub.", "type": "object", "properties": { "id": { + "description": "Unique identifier of the repository", "type": "integer", "format": "int64", "examples": [ - 1296269 + 42 ] }, "node_id": { @@ -29929,9 +29379,10 @@ ] }, "name": { + "description": "The name of the repository.", "type": "string", "examples": [ - "Hello-World" + "Team Environment" ] }, "full_name": { @@ -29940,6 +29391,96 @@ "octocat/Hello-World" ] }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, "owner": { "title": "Simple User", "description": "A GitHub user.", @@ -30109,6 +29650,8 @@ ] }, "private": { + "description": "Whether the repository is private or public.", + "default": false, "type": "boolean" }, "html_url": { @@ -30245,7 +29788,10 @@ ] }, "git_url": { - "type": "string" + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] }, "issue_comment_url": { "type": "string", @@ -30316,7 +29862,10 @@ ] }, "ssh_url": { - "type": "string" + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] }, "stargazers_url": { "type": "string", @@ -30366,12 +29915,19 @@ ] }, "clone_url": { - "type": "string" + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] }, "mirror_url": { "type": [ "string", "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { @@ -30382,12 +29938,20 @@ ] }, "svn_url": { - "type": "string" + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] }, "homepage": { "type": [ "string", "null" + ], + "format": "uri", + "examples": [ + "https://github.com" ] }, "language": { @@ -30397,26 +29961,50 @@ ] }, "forks_count": { - "type": "integer" + "type": "integer", + "examples": [ + 9 + ] }, "stargazers_count": { - "type": "integer" + "type": "integer", + "examples": [ + 80 + ] }, "watchers_count": { - "type": "integer" + "type": "integer", + "examples": [ + 80 + ] }, "size": { "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" + "type": "integer", + "examples": [ + 108 + ] }, "default_branch": { - "type": "string" + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] }, "open_issues_count": { - "type": "integer" + "type": "integer", + "examples": [ + 0 + ] }, "is_template": { - "type": "boolean" + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] }, "topics": { "type": "array", @@ -30425,30 +30013,61 @@ } }, "has_issues": { - "type": "boolean" + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] }, "has_projects": { - "type": "boolean" + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] }, "has_wiki": { - "type": "boolean" + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] }, "has_pages": { "type": "boolean" }, "has_downloads": { - "type": "boolean" + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, + "examples": [ + true + ] }, "has_discussions": { - "type": "boolean" + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] }, "archived": { + "description": "Whether the repository is archived.", + "default": false, "type": "boolean" }, "disabled": { - "type": "boolean" + "type": "boolean", + "description": "Returns whether or not this repository disabled." }, "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", "type": "string" }, "pushed_at": { @@ -30481,250 +30100,136 @@ "2011-01-26T19:14:43Z" ] }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", "examples": [ - "admin" + true ] }, "temp_clone_token": { "type": "string" }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "contributor_covenant" - ] - }, - "name": { - "type": "string", - "examples": [ - "Contributor Covenant" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/codes_of_conduct/contributor_covenant" - ] - }, - "body": { - "type": "string", - "examples": [ - "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" - ] - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true ] }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - } + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] }, - "forks": { - "type": "integer", + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", "examples": [ - 0 + false ] }, - "open_issues": { - "type": "integer", + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", "examples": [ - 0 + false ] }, - "watchers": { - "type": "integer", + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", "examples": [ - 0 + true ] }, "allow_forking": { + "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { - "type": "boolean", + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", "examples": [ - false + "\"2020-07-09T00:17:42Z\"" ] }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "code_security": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_non_provider_patterns": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_ai_detection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } + "lexical_search_ok": { + "type": "boolean" }, - "secret_scanning_validity_checks": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } + "lexical_commit_sha": { + "type": "string" } } - }, - "custom_properties": { - "type": "object", - "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", - "additionalProperties": true } }, "required": [ @@ -30773,275 +30278,79 @@ "tags_url", "teams_url", "trees_url", - "url" + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" ] } + }, + "single_file": { + "type": [ + "string", + "null" + ], + "examples": [ + "config.yaml" + ] + }, + "repository_selection": { + "description": "Describe whether all repositories have been selected or there's a selection involved", + "type": "string", + "enum": [ + "all", + "selected" + ] } - } - } - } - } - ], - "previews": [], - "descriptionHTML": "

Lists all repositories that can access an organization variable\nthat is available to selected repositories.

\n

Authenticated users must have collaborator access to a repository to create, update, or read variables.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

", - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "409", - "description": "

Response when the visibility of the variable is not set to selected

" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "put", - "requestPath": "/orgs/{org}/actions/variables/{name}/repositories", - "title": "Set selected repositories for an organization variable", - "category": "actions", - "subcategory": "variables", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "name", - "description": "

The name of the variable.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "array of integers", - "name": "selected_repository_ids", - "in": "body", - "description": "

The IDs of the repositories that can access the organization variable.

", - "isRequired": true - } - ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Variables\" organization permissions": "write" - } - ] - }, - "codeExamples": [ - { - "key": "default", - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "selected_repository_ids": [ - 64780797 + }, + "required": [ + "token", + "expires_at" ] - }, - "parameters": { - "org": "ORG", - "name": "NAME" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "previews": [], - "descriptionHTML": "

Replaces all repositories for an organization variable that is available\nto selected repositories. Organization variables that are available to selected\nrepositories have their visibility field set to selected.

\n

Authenticated users must have collaborator access to a repository to create, update, or read variables.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

", - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "409", - "description": "

Response when the visibility of the variable is not set to selected

" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "put", - "requestPath": "/orgs/{org}/actions/variables/{name}/repositories/{repository_id}", - "title": "Add selected repository to an organization variable", - "category": "actions", - "subcategory": "variables", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "name", - "description": "

The name of the variable.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repository_id", - "in": "path", - "required": true, - "schema": { - "type": "integer" - }, - "description": "" - } - ], - "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Variables\" organization permissions": "write", - "\"Metadata\" repository permissions": "read" - } - ] - }, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "name": "NAME", - "repository_id": "REPOSITORY_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "previews": [], - "descriptionHTML": "

Adds a repository to an organization variable that is available to selected repositories.\nOrganization variables that are available to selected repositories have their visibility field set to selected.

\n

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "409", - "description": "

Response when the visibility of the variable is not set to selected

" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/variables/{name}/repositories/{repository_id}", - "title": "Remove selected repository from an organization variable", - "category": "actions", - "subcategory": "variables", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "name", - "description": "

The name of the variable.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repository_id", - "in": "path", - "required": true, - "schema": { - "type": "integer" - }, - "description": "" - } - ], - "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Variables\" organization permissions": "write", - "\"Metadata\" repository permissions": "read" - } - ] - }, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "name": "NAME", - "repository_id": "REPOSITORY_ID" } - }, - "response": { - "statusCode": "204", - "description": "

Response

" } } ], "previews": [], - "descriptionHTML": "

Removes a repository from an organization variable that is\navailable to selected repositories. Organization variables that are available to\nselected repositories have their visibility field set to selected.

\n

Authenticated users must have collaborator access to a repository to create, update, or read variables.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

", + "descriptionHTML": "

Returns a token that you can pass to the config script. The token expires after one hour.

\n

For example, you can replace TOKEN in the following example with the registration token provided by this endpoint to configure your self-hosted runner:

\n
./config.sh --url https://github.com/octo-org --token TOKEN\n
\n

Authenticated users must have admin access to the repository to use this endpoint.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "409", - "description": "

Response when the visibility of the variable is not set to selected

" + "httpStatusCode": "201", + "description": "

Created

" } ] }, { "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/organization-variables", - "title": "List repository organization variables", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/actions/runners/remove-token", + "title": "Create a remove token for a repository", "category": "actions", - "subcategory": "variables", + "subcategory": "self-hosted-runners", "parameters": [ { "name": "owner", @@ -31060,24 +30369,6 @@ "schema": { "type": "string" } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 30). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 10 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } } ], "bodyParameters": [], @@ -31087,7 +30378,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Variables\" repository permissions": "read" + "\"Administration\" repository permissions": "write" } ] }, @@ -31103,102 +30394,1037 @@ } }, "response": { - "statusCode": "200", + "statusCode": "201", "contentType": "application/json", "description": "

Response

", "example": { - "total_count": 2, - "variables": [ - { - "name": "USERNAME", - "value": "octocat", - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z" - }, - { - "name": "EMAIL", - "value": "octocat@github.com", - "created_at": "2020-01-10T10:59:22Z", - "updated_at": "2020-01-11T11:59:22Z" - } - ] + "token": "AABF3JGZDX3P5PMEXLND6TS6FCWO6", + "expires_at": "2020-01-29T12:13:35.123-08:00" }, "schema": { + "title": "Authentication Token", + "description": "Authentication Token", "type": "object", - "required": [ - "total_count", - "variables" - ], "properties": { - "total_count": { - "type": "integer" + "token": { + "description": "The token used for authentication", + "type": "string", + "examples": [ + "v1.1f699f1069f60xxx" + ] }, - "variables": { + "expires_at": { + "description": "The time this token expires", + "type": "string", + "format": "date-time", + "examples": [ + "2016-07-11T22:14:10Z" + ] + }, + "permissions": { + "type": "object", + "examples": [ + { + "issues": "read", + "deployments": "write" + } + ] + }, + "repositories": { + "description": "The repositories this token has access to", "type": "array", "items": { - "title": "Actions Variable", + "title": "Repository", + "description": "A repository on GitHub.", "type": "object", "properties": { - "name": { - "description": "The name of the variable.", - "type": "string", + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", "examples": [ - "USERNAME" + 42 ] }, - "value": { - "description": "The value of the variable.", + "node_id": { "type": "string", "examples": [ - "octocat" + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, - "created_at": { - "description": "The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "name": { + "description": "The name of the repository.", "type": "string", - "format": "date-time", "examples": [ - "2019-01-24T22:45:36.000Z" + "Team Environment" ] }, - "updated_at": { - "description": "The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "full_name": { "type": "string", - "format": "date-time", "examples": [ - "2019-01-24T22:45:36.000Z" + "octocat/Hello-World" ] - } - }, - "required": [ - "name", - "value", + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "type": "string" + } + } + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", "created_at", "updated_at" ] } + }, + "single_file": { + "type": [ + "string", + "null" + ], + "examples": [ + "config.yaml" + ] + }, + "repository_selection": { + "description": "Describe whether all repositories have been selected or there's a selection involved", + "type": "string", + "enum": [ + "all", + "selected" + ] } - } + }, + "required": [ + "token", + "expires_at" + ] } } } ], "previews": [], - "descriptionHTML": "

Lists all organization variables shared with a repository.

\n

Authenticated users must have collaborator access to a repository to create, update, or read variables.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", + "descriptionHTML": "

Returns a token that you can pass to the config script to remove a self-hosted runner from an repository. The token expires after one hour.

\n

For example, you can replace TOKEN in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization:

\n
./config.sh remove --token TOKEN\n
\n

Authenticated users must have admin access to the repository to use this endpoint.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { - "httpStatusCode": "200", - "description": "

OK

" + "httpStatusCode": "201", + "description": "

Created

" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/variables", - "title": "List repository variables", + "requestPath": "/repos/{owner}/{repo}/actions/runners/{runner_id}", + "title": "Get a self-hosted runner for a repository", "category": "actions", - "subcategory": "variables", + "subcategory": "self-hosted-runners", "parameters": [ { "name": "owner", @@ -31219,21 +31445,12 @@ } }, { - "name": "per_page", - "description": "

The number of results per page (max 30). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 10 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", + "name": "runner_id", + "description": "

Unique identifier of the self-hosted runner.

", + "in": "path", + "required": true, "schema": { - "type": "integer", - "default": 1 + "type": "integer" } } ], @@ -31244,7 +31461,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Variables\" repository permissions": "read" + "\"Administration\" repository permissions": "read" } ] }, @@ -31256,7 +31473,8 @@ "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", - "repo": "REPO" + "repo": "REPO", + "runner_id": "RUNNER_ID" } }, "response": { @@ -31264,84 +31482,125 @@ "contentType": "application/json", "description": "

Response

", "example": { - "total_count": 2, - "variables": [ + "id": 23, + "name": "MBP", + "os": "macos", + "status": "online", + "busy": true, + "ephemeral": false, + "labels": [ { - "name": "USERNAME", - "value": "octocat", - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z" + "id": 5, + "name": "self-hosted", + "type": "read-only" }, { - "name": "EMAIL", - "value": "octocat@github.com", - "created_at": "2020-01-10T10:59:22Z", - "updated_at": "2020-01-11T11:59:22Z" + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 20, + "name": "macOS", + "type": "read-only" + }, + { + "id": 21, + "name": "no-gpu", + "type": "custom" } ] }, "schema": { + "title": "Self hosted runners", + "description": "A self hosted runner", "type": "object", - "required": [ - "total_count", - "variables" - ], "properties": { - "total_count": { - "type": "integer" + "id": { + "description": "The ID of the runner.", + "type": "integer", + "examples": [ + 5 + ] }, - "variables": { + "runner_group_id": { + "description": "The ID of the runner group.", + "type": "integer", + "examples": [ + 1 + ] + }, + "name": { + "description": "The name of the runner.", + "type": "string", + "examples": [ + "iMac" + ] + }, + "os": { + "description": "The Operating System of the runner.", + "type": "string", + "examples": [ + "macos" + ] + }, + "status": { + "description": "The status of the runner.", + "type": "string", + "examples": [ + "online" + ] + }, + "busy": { + "type": "boolean" + }, + "labels": { "type": "array", "items": { - "title": "Actions Variable", + "title": "Self hosted runner label", + "description": "A label for a self hosted runner", "type": "object", "properties": { - "name": { - "description": "The name of the variable.", - "type": "string", - "examples": [ - "USERNAME" - ] - }, - "value": { - "description": "The value of the variable.", - "type": "string", - "examples": [ - "octocat" - ] + "id": { + "type": "integer", + "description": "Unique identifier of the label." }, - "created_at": { - "description": "The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "name": { "type": "string", - "format": "date-time", - "examples": [ - "2019-01-24T22:45:36.000Z" - ] + "description": "Name of the label." }, - "updated_at": { - "description": "The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "type": { "type": "string", - "format": "date-time", - "examples": [ - "2019-01-24T22:45:36.000Z" + "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", + "enum": [ + "read-only", + "custom" ] } }, "required": [ - "name", - "value", - "created_at", - "updated_at" + "name" ] } + }, + "ephemeral": { + "type": "boolean" } - } + }, + "required": [ + "id", + "name", + "os", + "status", + "busy", + "labels" + ] } } } ], "previews": [], - "descriptionHTML": "

Lists all repository variables.

\n

Authenticated users must have collaborator access to a repository to create, update, or read variables.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", + "descriptionHTML": "

Gets a specific self-hosted runner configured in a repository.

\n

Authenticated users must have admin access to the repository to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -31351,11 +31610,11 @@ }, { "serverUrl": "https://api.github.com", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/variables", - "title": "Create a repository variable", + "verb": "delete", + "requestPath": "/repos/{owner}/{repo}/actions/runners/{runner_id}", + "title": "Delete a self-hosted runner from a repository", "category": "actions", - "subcategory": "variables", + "subcategory": "self-hosted-runners", "parameters": [ { "name": "owner", @@ -31374,31 +31633,103 @@ "schema": { "type": "string" } + }, + { + "name": "runner_id", + "description": "

Unique identifier of the self-hosted runner.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], - "bodyParameters": [ + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Administration\" repository permissions": "write" + } + ] + }, + "codeExamples": [ { - "type": "string", - "name": "name", - "in": "body", - "description": "

The name of the variable.

", - "isRequired": true + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "runner_id": "RUNNER_ID" + } + }, + "response": { + "statusCode": "204", + "description": "

Response

" + } + } + ], + "previews": [], + "descriptionHTML": "

Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.

\n

Authenticated users must have admin access to the repository to use this endpoint.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "

No Content

" }, { - "type": "string", - "name": "value", - "in": "body", - "description": "

The value of the variable.

", - "isRequired": true + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels", + "title": "List labels for a self-hosted runner for a repository", + "category": "actions", + "subcategory": "self-hosted-runners", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "runner_id", + "description": "

Unique identifier of the self-hosted runner.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], + "bodyParameters": [], "progAccess": { "userToServerRest": true, "serverToServer": true, "fineGrainedPat": true, "permissions": [ { - "\"Variables\" repository permissions": "write" + "\"Administration\" repository permissions": "read" } ] }, @@ -31406,49 +31737,107 @@ { "key": "default", "request": { - "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "name": "USERNAME", - "value": "octocat" - }, "parameters": { "owner": "OWNER", - "repo": "REPO" + "repo": "REPO", + "runner_id": "RUNNER_ID" } }, "response": { - "statusCode": "201", + "statusCode": "200", "contentType": "application/json", "description": "

Response

", - "example": null, + "example": { + "total_count": 4, + "labels": [ + { + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 20, + "name": "macOS", + "type": "read-only" + }, + { + "id": 21, + "name": "no-gpu", + "type": "custom" + } + ] + }, "schema": { - "title": "Empty Object", - "description": "An object without any properties.", "type": "object", - "properties": {}, - "additionalProperties": false + "required": [ + "total_count", + "labels" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "labels": { + "type": "array", + "items": { + "title": "Self hosted runner label", + "description": "A label for a self hosted runner", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier of the label." + }, + "name": { + "type": "string", + "description": "Name of the label." + }, + "type": { + "type": "string", + "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", + "enum": [ + "read-only", + "custom" + ] + } + }, + "required": [ + "name" + ] + } + } + } } } } ], "previews": [], - "descriptionHTML": "

Creates a repository variable that you can reference in a GitHub Actions workflow.

\n

Authenticated users must have collaborator access to a repository to create, update, or read variables.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", + "descriptionHTML": "

Lists all labels for a self-hosted runner configured in a repository.

\n

Authenticated users must have admin access to the repository to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { - "httpStatusCode": "201", - "description": "

Created

" + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" } ] }, { "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/variables/{name}", - "title": "Get a repository variable", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels", + "title": "Add custom labels to a self-hosted runner for a repository", "category": "actions", - "subcategory": "variables", + "subcategory": "self-hosted-runners", "parameters": [ { "name": "owner", @@ -31469,23 +31858,31 @@ } }, { - "name": "name", - "description": "

The name of the variable.

", + "name": "runner_id", + "description": "

Unique identifier of the self-hosted runner.

", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" } } ], - "bodyParameters": [], + "bodyParameters": [ + { + "type": "array of strings", + "name": "labels", + "in": "body", + "description": "

The names of the custom labels to add to the runner.

", + "isRequired": true + } + ], "progAccess": { "userToServerRest": true, "serverToServer": true, "fineGrainedPat": true, "permissions": [ { - "\"Variables\" repository permissions": "read" + "\"Administration\" repository permissions": "write" } ] }, @@ -31493,12 +31890,19 @@ { "key": "default", "request": { + "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "labels": [ + "gpu", + "accelerated" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", - "name": "NAME" + "runner_id": "RUNNER_ID" } }, "response": { @@ -31506,72 +31910,98 @@ "contentType": "application/json", "description": "

Response

", "example": { - "name": "USERNAME", - "value": "octocat", - "created_at": "2021-08-10T14:59:22Z", - "updated_at": "2022-01-10T14:59:22Z" + "total_count": 4, + "labels": [ + { + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 20, + "name": "macOS", + "type": "read-only" + }, + { + "id": 21, + "name": "no-gpu", + "type": "custom" + } + ] }, "schema": { - "title": "Actions Variable", "type": "object", + "required": [ + "total_count", + "labels" + ], "properties": { - "name": { - "description": "The name of the variable.", - "type": "string", - "examples": [ - "USERNAME" - ] - }, - "value": { - "description": "The value of the variable.", - "type": "string", - "examples": [ - "octocat" - ] - }, - "created_at": { - "description": "The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "type": "string", - "format": "date-time", - "examples": [ - "2019-01-24T22:45:36.000Z" - ] + "total_count": { + "type": "integer" }, - "updated_at": { - "description": "The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "type": "string", - "format": "date-time", - "examples": [ - "2019-01-24T22:45:36.000Z" - ] + "labels": { + "type": "array", + "items": { + "title": "Self hosted runner label", + "description": "A label for a self hosted runner", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier of the label." + }, + "name": { + "type": "string", + "description": "Name of the label." + }, + "type": { + "type": "string", + "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", + "enum": [ + "read-only", + "custom" + ] + } + }, + "required": [ + "name" + ] + } } - }, - "required": [ - "name", - "value", - "created_at", - "updated_at" - ] + } } } } ], "previews": [], - "descriptionHTML": "

Gets a specific variable in a repository.

\n

The authenticated user must have collaborator access to the repository to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", + "descriptionHTML": "

Adds custom labels to a self-hosted runner configured in a repository.

\n

Authenticated users must have admin access to the organization to use this endpoint.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" } ] }, { "serverUrl": "https://api.github.com", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/actions/variables/{name}", - "title": "Update a repository variable", + "verb": "put", + "requestPath": "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels", + "title": "Set custom labels for a self-hosted runner for a repository", "category": "actions", - "subcategory": "variables", + "subcategory": "self-hosted-runners", "parameters": [ { "name": "owner", @@ -31592,27 +32022,22 @@ } }, { - "name": "name", - "description": "

The name of the variable.

", + "name": "runner_id", + "description": "

Unique identifier of the self-hosted runner.

", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" } } ], "bodyParameters": [ { - "type": "string", - "name": "name", - "in": "body", - "description": "

The name of the variable.

" - }, - { - "type": "string", - "name": "value", + "type": "array of strings", + "name": "labels", "in": "body", - "description": "

The value of the variable.

" + "description": "

The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.

", + "isRequired": true } ], "progAccess": { @@ -31621,7 +32046,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Variables\" repository permissions": "write" + "\"Administration\" repository permissions": "write" } ] }, @@ -31633,37 +32058,114 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "name": "USERNAME", - "value": "octocat" + "labels": [ + "gpu", + "accelerated" + ] }, "parameters": { "owner": "OWNER", "repo": "REPO", - "name": "NAME" + "runner_id": "RUNNER_ID" } }, "response": { - "statusCode": "204", - "description": "

Response

" + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "total_count": 4, + "labels": [ + { + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 20, + "name": "macOS", + "type": "read-only" + }, + { + "id": 21, + "name": "no-gpu", + "type": "custom" + } + ] + }, + "schema": { + "type": "object", + "required": [ + "total_count", + "labels" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "labels": { + "type": "array", + "items": { + "title": "Self hosted runner label", + "description": "A label for a self hosted runner", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier of the label." + }, + "name": { + "type": "string", + "description": "Name of the label." + }, + "type": { + "type": "string", + "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", + "enum": [ + "read-only", + "custom" + ] + } + }, + "required": [ + "name" + ] + } + } + } + } } } ], "previews": [], - "descriptionHTML": "

Updates a repository variable that you can reference in a GitHub Actions workflow.

\n

Authenticated users must have collaborator access to a repository to create, update, or read variables.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", + "descriptionHTML": "

Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in a repository.

\n

Authenticated users must have admin access to the repository to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { - "httpStatusCode": "204", - "description": "

No Content

" + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/actions/variables/{name}", - "title": "Delete a repository variable", + "requestPath": "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels", + "title": "Remove all custom labels from a self-hosted runner for a repository", "category": "actions", - "subcategory": "variables", + "subcategory": "self-hosted-runners", "parameters": [ { "name": "owner", @@ -31684,12 +32186,12 @@ } }, { - "name": "name", - "description": "

The name of the variable.

", + "name": "runner_id", + "description": "

Unique identifier of the self-hosted runner.

", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" } } ], @@ -31700,7 +32202,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Variables\" repository permissions": "write" + "\"Administration\" repository permissions": "write" } ] }, @@ -31713,31 +32215,97 @@ "parameters": { "owner": "OWNER", "repo": "REPO", - "name": "NAME" + "runner_id": "RUNNER_ID" } }, "response": { - "statusCode": "204", - "description": "

Response

" + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "total_count": 3, + "labels": [ + { + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 20, + "name": "macOS", + "type": "read-only" + } + ] + }, + "schema": { + "type": "object", + "required": [ + "total_count", + "labels" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "labels": { + "type": "array", + "items": { + "title": "Self hosted runner label", + "description": "A label for a self hosted runner", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier of the label." + }, + "name": { + "type": "string", + "description": "Name of the label." + }, + "type": { + "type": "string", + "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", + "enum": [ + "read-only", + "custom" + ] + } + }, + "required": [ + "name" + ] + } + } + } + } } } ], "previews": [], - "descriptionHTML": "

Deletes a repository variable using the variable name.

\n

Authenticated users must have collaborator access to a repository to create, update, or read variables.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", + "descriptionHTML": "

Remove all custom labels from a self-hosted runner configured in a\nrepository. Returns the remaining read-only labels from the runner.

\n

Authenticated users must have admin access to the repository to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { - "httpStatusCode": "204", - "description": "

No Content

" + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" } ] }, { "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/variables", - "title": "List environment variables", + "verb": "delete", + "requestPath": "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels/{name}", + "title": "Remove a custom label from a self-hosted runner for a repository", "category": "actions", - "subcategory": "variables", + "subcategory": "self-hosted-runners", "parameters": [ { "name": "owner", @@ -31758,10 +32326,153 @@ } }, { - "name": "environment_name", + "name": "runner_id", + "description": "

Unique identifier of the self-hosted runner.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "name", + "description": "

The name of a self-hosted runner's custom label.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Administration\" repository permissions": "write" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "runner_id": "RUNNER_ID", + "name": "NAME" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "total_count": 4, + "labels": [ + { + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 20, + "name": "macOS", + "type": "read-only" + }, + { + "id": 21, + "name": "no-gpu", + "type": "custom" + } + ] + }, + "schema": { + "type": "object", + "required": [ + "total_count", + "labels" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "labels": { + "type": "array", + "items": { + "title": "Self hosted runner label", + "description": "A label for a self hosted runner", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier of the label." + }, + "name": { + "type": "string", + "description": "Name of the label." + }, + "type": { + "type": "string", + "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", + "enum": [ + "read-only", + "custom" + ] + } + }, + "required": [ + "name" + ] + } + } + } + } + } + } + ], + "previews": [], + "descriptionHTML": "

Remove a custom label from a self-hosted runner configured\nin a repository. Returns the remaining labels from the runner.

\n

This endpoint returns a 404 Not Found status if the custom label is not\npresent on the runner.

\n

Authenticated users must have admin access to the repository to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + } + ] + } + ], + "variables": [ + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/actions/variables", + "title": "List organization variables", + "category": "actions", + "subcategory": "variables", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", "in": "path", "required": true, - "description": "

The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F.

", "schema": { "type": "string" } @@ -31792,7 +32503,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Environments\" repository permissions": "read" + "\"Variables\" organization permissions": "read" } ] }, @@ -31803,9 +32514,7 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "owner": "OWNER", - "repo": "REPO", - "environment_name": "ENVIRONMENT_NAME" + "org": "ORG" } }, "response": { @@ -31813,19 +32522,29 @@ "contentType": "application/json", "description": "

Response

", "example": { - "total_count": 2, + "total_count": 3, "variables": [ { "name": "USERNAME", "value": "octocat", "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z" + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "private" }, { - "name": "EMAIL", + "name": "ACTIONS_RUNNER_DEBUG", + "value": true, + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "all" + }, + { + "name": "ADMIN_EMAIL", "value": "octocat@github.com", - "created_at": "2020-01-10T10:59:22Z", - "updated_at": "2020-01-11T11:59:22Z" + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "selected", + "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/variables/ADMIN_EMAIL/repositories" } ] }, @@ -31842,7 +32561,8 @@ "variables": { "type": "array", "items": { - "title": "Actions Variable", + "title": "Actions Variable for an Organization", + "description": "Organization variable for GitHub Actions.", "type": "object", "properties": { "name": { @@ -31874,13 +32594,30 @@ "examples": [ "2019-01-24T22:45:36.000Z" ] + }, + "visibility": { + "description": "Visibility of a variable", + "enum": [ + "all", + "private", + "selected" + ], + "type": "string" + }, + "selected_repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/org/variables/USERNAME/repositories" + ] } }, "required": [ "name", "value", "created_at", - "updated_at" + "updated_at", + "visibility" ] } } @@ -31890,45 +32627,27 @@ } ], "previews": [], - "descriptionHTML": "

Lists all environment variables.

\n

Authenticated users must have collaborator access to a repository to create, update, or read variables.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Lists all organization variables.

\n

Authenticated users must have collaborator access to a repository to create, update, or read variables.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

" }, { "serverUrl": "https://api.github.com", "verb": "post", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/variables", - "title": "Create an environment variable", + "requestPath": "/orgs/{org}/actions/variables", + "title": "Create an organization variable", "category": "actions", "subcategory": "variables", "parameters": [ { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "environment_name", + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", "in": "path", "required": true, - "description": "

The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F.

", "schema": { "type": "string" } @@ -31948,6 +32667,24 @@ "in": "body", "description": "

The value of the variable.

", "isRequired": true + }, + { + "type": "string", + "name": "visibility", + "in": "body", + "description": "

The type of repositories in the organization that can access the variable. selected means only the repositories specified by selected_repository_ids can access the variable.

", + "isRequired": true, + "enum": [ + "all", + "private", + "selected" + ] + }, + { + "type": "array of integers", + "name": "selected_repository_ids", + "in": "body", + "description": "

An array of repository ids that can access the organization variable. You can only provide a list of repository ids when the visibility is set to selected.

" } ], "progAccess": { @@ -31956,7 +32693,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Environments\" repository permissions": "write" + "\"Variables\" organization permissions": "write" } ] }, @@ -31969,18 +32706,21 @@ "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "USERNAME", - "value": "octocat" + "value": "octocat", + "visibility": "selected", + "selected_repository_ids": [ + 1296269, + 1296280 + ] }, "parameters": { - "owner": "OWNER", - "repo": "REPO", - "environment_name": "ENVIRONMENT_NAME" + "org": "ORG" } }, "response": { "statusCode": "201", "contentType": "application/json", - "description": "

Response

", + "description": "

Response when creating a variable

", "example": null, "schema": { "title": "Empty Object", @@ -31993,45 +32733,27 @@ } ], "previews": [], - "descriptionHTML": "

Create an environment variable that you can reference in a GitHub Actions workflow.

\n

Authenticated users must have collaborator access to a repository to create, update, or read variables.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", + "descriptionHTML": "

Creates an organization variable that you can reference in a GitHub Actions workflow.

\n

Authenticated users must have collaborator access to a repository to create, update, or read variables.

\n

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "201", - "description": "

Created

" + "description": "

Response when creating a variable

" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}", - "title": "Get an environment variable", + "requestPath": "/orgs/{org}/actions/variables/{name}", + "title": "Get an organization variable", "category": "actions", "subcategory": "variables", "parameters": [ { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "environment_name", + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", "in": "path", "required": true, - "description": "

The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F.

", "schema": { "type": "string" } @@ -32053,7 +32775,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Environments\" repository permissions": "read" + "\"Variables\" organization permissions": "read" } ] }, @@ -32064,9 +32786,7 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "owner": "OWNER", - "repo": "REPO", - "environment_name": "ENVIRONMENT_NAME", + "org": "ORG", "name": "NAME" } }, @@ -32077,11 +32797,14 @@ "example": { "name": "USERNAME", "value": "octocat", - "created_at": "2021-08-10T14:59:22Z", - "updated_at": "2022-01-10T14:59:22Z" + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "selected", + "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/variables/USERNAME/repositories" }, "schema": { - "title": "Actions Variable", + "title": "Actions Variable for an Organization", + "description": "Organization variable for GitHub Actions.", "type": "object", "properties": { "name": { @@ -32113,47 +32836,55 @@ "examples": [ "2019-01-24T22:45:36.000Z" ] + }, + "visibility": { + "description": "Visibility of a variable", + "enum": [ + "all", + "private", + "selected" + ], + "type": "string" + }, + "selected_repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/org/variables/USERNAME/repositories" + ] } }, "required": [ "name", "value", "created_at", - "updated_at" + "updated_at", + "visibility" ] } } } ], "previews": [], - "descriptionHTML": "

Gets a specific variable in an environment.

\n

Authenticated users must have collaborator access to a repository to create, update, or read variables.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Gets a specific variable in an organization.

\n

The authenticated user must have collaborator access to a repository to create, update, or read variables.

\n

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" }, { "serverUrl": "https://api.github.com", "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}", - "title": "Update an environment variable", + "requestPath": "/orgs/{org}/actions/variables/{name}", + "title": "Update an organization variable", "category": "actions", "subcategory": "variables", "parameters": [ { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", "in": "path", "required": true, "schema": { @@ -32168,15 +32899,6 @@ "schema": { "type": "string" } - }, - { - "name": "environment_name", - "in": "path", - "required": true, - "description": "

The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F.

", - "schema": { - "type": "string" - } } ], "bodyParameters": [ @@ -32191,6 +32913,23 @@ "name": "value", "in": "body", "description": "

The value of the variable.

" + }, + { + "type": "string", + "name": "visibility", + "in": "body", + "description": "

The type of repositories in the organization that can access the variable. selected means only the repositories specified by selected_repository_ids can access the variable.

", + "enum": [ + "all", + "private", + "selected" + ] + }, + { + "type": "array of integers", + "name": "selected_repository_ids", + "in": "body", + "description": "

An array of repository ids that can access the organization variable. You can only provide a list of repository ids when the visibility is set to selected.

" } ], "progAccess": { @@ -32199,7 +32938,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Environments\" repository permissions": "write" + "\"Variables\" organization permissions": "write" } ] }, @@ -32212,14 +32951,17 @@ "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "USERNAME", - "value": "octocat" + "value": "octocat", + "visibility": "selected", + "selected_repository_ids": [ + 1296269, + 1296280 + ] }, "parameters": { - "owner": "OWNER", - "repo": "REPO", - "name": "NAME", - "environment_name": "ENVIRONMENT_NAME" - } + "org": "ORG", + "name": "NAME" + } }, "response": { "statusCode": "204", @@ -32228,7 +32970,7 @@ } ], "previews": [], - "descriptionHTML": "

Updates an environment variable that you can reference in a GitHub Actions workflow.

\n

Authenticated users must have collaborator access to a repository to create, update, or read variables.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", + "descriptionHTML": "

Updates an organization variable that you can reference in a GitHub Actions workflow.

\n

Authenticated users must have collaborator access to a repository to create, update, or read variables.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

", "statusCodes": [ { "httpStatusCode": "204", @@ -32239,23 +32981,14 @@ { "serverUrl": "https://api.github.com", "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}", - "title": "Delete an environment variable", + "requestPath": "/orgs/{org}/actions/variables/{name}", + "title": "Delete an organization variable", "category": "actions", "subcategory": "variables", "parameters": [ { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", "in": "path", "required": true, "schema": { @@ -32270,15 +33003,6 @@ "schema": { "type": "string" } - }, - { - "name": "environment_name", - "in": "path", - "required": true, - "description": "

The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F.

", - "schema": { - "type": "string" - } } ], "bodyParameters": [], @@ -32288,7 +33012,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Environments\" repository permissions": "write" + "\"Variables\" organization permissions": "write" } ] }, @@ -32299,10 +33023,8 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "owner": "OWNER", - "repo": "REPO", - "name": "NAME", - "environment_name": "ENVIRONMENT_NAME" + "org": "ORG", + "name": "NAME" } }, "response": { @@ -32312,27 +33034,25 @@ } ], "previews": [], - "descriptionHTML": "

Deletes an environment variable using the variable name.

\n

Authenticated users must have collaborator access to a repository to create, update, or read variables.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", + "descriptionHTML": "

Deletes an organization variable using the variable name.

\n

Authenticated users must have collaborator access to a repository to create, update, or read variables.

\n

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } ] - } - ], - "workflow-jobs": [ + }, { "serverUrl": "https://api.github.com", "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/jobs/{job_id}", - "title": "Get a job for a workflow run", + "requestPath": "/orgs/{org}/actions/variables/{name}/repositories", + "title": "List selected repositories for an organization variable", "category": "actions", - "subcategory": "workflow-jobs", + "subcategory": "variables", "parameters": [ { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", "in": "path", "required": true, "schema": { @@ -32340,8 +33060,8 @@ } }, { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", + "name": "name", + "description": "

The name of the variable.

", "in": "path", "required": true, "schema": { @@ -32349,12 +33069,21 @@ } }, { - "name": "job_id", - "description": "

The unique identifier of the job.

", - "in": "path", - "required": true, + "name": "page", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "in": "query", "schema": { - "type": "integer" + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "in": "query", + "schema": { + "type": "integer", + "default": 30 } } ], @@ -32365,10 +33094,9 @@ "fineGrainedPat": true, "permissions": [ { - "\"Actions\" repository permissions": "read" + "\"Variables\" organization permissions": "read" } - ], - "allowsPublicRead": true + ] }, "codeExamples": [ { @@ -32377,9 +33105,8 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "owner": "OWNER", - "repo": "REPO", - "job_id": "JOB_ID" + "org": "ORG", + "name": "NAME" } }, "response": { @@ -32387,440 +33114,987 @@ "contentType": "application/json", "description": "

Response

", "example": { - "id": 399444496, - "run_id": 29679449, - "run_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/29679449", - "node_id": "MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==", - "head_sha": "f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0", - "url": "https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496", - "html_url": "https://github.com/octo-org/octo-repo/runs/29679449/jobs/399444496", - "status": "completed", - "conclusion": "success", - "started_at": "2020-01-20T17:42:40Z", - "completed_at": "2020-01-20T17:44:39Z", - "name": "build", - "steps": [ - { - "name": "Set up job", - "status": "completed", - "conclusion": "success", - "number": 1, - "started_at": "2020-01-20T09:42:40.000-08:00", - "completed_at": "2020-01-20T09:42:41.000-08:00" - }, - { - "name": "Run actions/checkout@v2", - "status": "completed", - "conclusion": "success", - "number": 2, - "started_at": "2020-01-20T09:42:41.000-08:00", - "completed_at": "2020-01-20T09:42:45.000-08:00" - }, - { - "name": "Set up Ruby", - "status": "completed", - "conclusion": "success", - "number": 3, - "started_at": "2020-01-20T09:42:45.000-08:00", - "completed_at": "2020-01-20T09:42:45.000-08:00" - }, - { - "name": "Run actions/cache@v3", - "status": "completed", - "conclusion": "success", - "number": 4, - "started_at": "2020-01-20T09:42:45.000-08:00", - "completed_at": "2020-01-20T09:42:48.000-08:00" - }, - { - "name": "Install Bundler", - "status": "completed", - "conclusion": "success", - "number": 5, - "started_at": "2020-01-20T09:42:48.000-08:00", - "completed_at": "2020-01-20T09:42:52.000-08:00" - }, - { - "name": "Install Gems", - "status": "completed", - "conclusion": "success", - "number": 6, - "started_at": "2020-01-20T09:42:52.000-08:00", - "completed_at": "2020-01-20T09:42:53.000-08:00" - }, - { - "name": "Run Tests", - "status": "completed", - "conclusion": "success", - "number": 7, - "started_at": "2020-01-20T09:42:53.000-08:00", - "completed_at": "2020-01-20T09:42:59.000-08:00" - }, - { - "name": "Deploy to Heroku", - "status": "completed", - "conclusion": "success", - "number": 8, - "started_at": "2020-01-20T09:42:59.000-08:00", - "completed_at": "2020-01-20T09:44:39.000-08:00" - }, - { - "name": "Post actions/cache@v3", - "status": "completed", - "conclusion": "success", - "number": 16, - "started_at": "2020-01-20T09:44:39.000-08:00", - "completed_at": "2020-01-20T09:44:39.000-08:00" - }, + "total_count": 1, + "repositories": [ { - "name": "Complete job", - "status": "completed", - "conclusion": "success", - "number": 17, - "started_at": "2020-01-20T09:44:39.000-08:00", - "completed_at": "2020-01-20T09:44:39.000-08:00" + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" } - ], - "check_run_url": "https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496", - "labels": [ - "self-hosted", - "foo", - "bar" - ], - "runner_id": 1, - "runner_name": "my runner", - "runner_group_id": 2, - "runner_group_name": "my runner group", - "workflow_name": "CI", - "head_branch": "main" + ] }, "schema": { - "title": "Job", - "description": "Information of a job execution in a workflow run", "type": "object", + "required": [ + "total_count", + "repositories" + ], "properties": { - "id": { - "description": "The id of the job.", - "type": "integer", - "examples": [ - 21 - ] - }, - "run_id": { - "description": "The id of the associated workflow run.", - "type": "integer", - "examples": [ - 5 - ] - }, - "run_url": { - "type": "string", - "examples": [ - "https://api.github.com/repos/github/hello-world/actions/runs/5" - ] - }, - "run_attempt": { - "type": "integer", - "description": "Attempt number of the associated workflow run, 1 for first attempt and higher if the workflow was re-run.", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDg6Q2hlY2tSdW40" - ] - }, - "head_sha": { - "description": "The SHA of the commit that is being run.", - "type": "string", - "examples": [ - "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d" - ] - }, - "url": { - "type": "string", - "examples": [ - "https://api.github.com/repos/github/hello-world/actions/jobs/21" - ] - }, - "html_url": { - "type": [ - "string", - "null" - ], - "examples": [ - "https://github.com/github/hello-world/runs/4" - ] - }, - "status": { - "description": "The phase of the lifecycle that the job is currently in.", - "type": "string", - "enum": [ - "queued", - "in_progress", - "completed", - "waiting", - "requested", - "pending" - ], - "examples": [ - "queued" - ] - }, - "conclusion": { - "description": "The outcome of the job.", - "type": [ - "string", - "null" - ], - "enum": [ - "success", - "failure", - "neutral", - "cancelled", - "skipped", - "timed_out", - "action_required", - null - ], - "examples": [ - "success" - ] - }, - "created_at": { - "description": "The time that the job created, in ISO 8601 format.", - "format": "date-time", - "type": "string", - "examples": [ - "2019-08-08T08:00:00-07:00" - ] - }, - "started_at": { - "description": "The time that the job started, in ISO 8601 format.", - "format": "date-time", - "type": "string", - "examples": [ - "2019-08-08T08:00:00-07:00" - ] - }, - "completed_at": { - "description": "The time that the job finished, in ISO 8601 format.", - "format": "date-time", - "type": [ - "string", - "null" - ], - "examples": [ - "2019-08-08T08:00:00-07:00" - ] - }, - "name": { - "description": "The name of the job.", - "type": "string", - "examples": [ - "test-coverage" - ] + "total_count": { + "type": "integer" }, - "steps": { - "description": "Steps in this job.", + "repositories": { "type": "array", "items": { + "title": "Minimal Repository", + "description": "Minimal Repository", "type": "object", - "required": [ - "name", - "status", - "conclusion", - "number" - ], "properties": { - "status": { - "description": "The phase of the lifecycle that the job is currently in.", + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1296269 + ] + }, + "node_id": { "type": "string", - "enum": [ - "queued", - "in_progress", - "completed" - ], "examples": [ - "queued" + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, - "conclusion": { - "description": "The outcome of the job.", + "name": { + "type": "string", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { "type": [ "string", "null" ], "examples": [ - "success" + "This your first repo!" ] }, - "name": { - "description": "The name of the job.", + "fork": { + "type": "boolean" + }, + "url": { "type": "string", + "format": "uri", "examples": [ - "test-coverage" + "https://api.github.com/repos/octocat/Hello-World" ] }, - "number": { - "type": "integer", + "archive_url": { + "type": "string", "examples": [ - 1 + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, - "started_at": { - "description": "The time that the step started, in ISO 8601 format.", - "format": "date-time", + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "has_discussions": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { "type": [ "string", "null" ], + "format": "date-time", "examples": [ - "2019-08-08T08:00:00-07:00" + "2011-01-26T19:06:43Z" ] }, - "completed_at": { - "description": "The time that the job finished, in ISO 8601 format.", + "created_at": { + "type": [ + "string", + "null" + ], "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { "type": [ "string", "null" ], + "format": "date-time", "examples": [ - "2019-08-08T08:00:00-07:00" + "2011-01-26T19:14:43Z" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "role_name": { + "type": "string", + "examples": [ + "admin" + ] + }, + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "code_of_conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "contributor_covenant" + ] + }, + "name": { + "type": "string", + "examples": [ + "Contributor Covenant" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/codes_of_conduct/contributor_covenant" + ] + }, + "body": { + "type": "string", + "examples": [ + "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" + ] + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "key", + "name" + ] + }, + "license": { + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + } + }, + "forks": { + "type": "integer", + "examples": [ + 0 + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 0 + ] + }, + "watchers": { + "type": "integer", + "examples": [ + 0 + ] + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false ] + }, + "security_and_analysis": { + "type": [ + "object", + "null" + ], + "properties": { + "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "code_security": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "dependabot_security_updates": { + "description": "Enable or disable Dependabot security updates for the repository.", + "type": "object", + "properties": { + "status": { + "description": "The enablement status of Dependabot security updates for the repository.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_push_protection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_non_provider_patterns": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_validity_checks": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + } + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true } - } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" + ] } - }, - "check_run_url": { - "type": "string", - "examples": [ - "https://api.github.com/repos/github/hello-world/check-runs/4" - ] - }, - "labels": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Labels for the workflow job. Specified by the \"runs_on\" attribute in the action's workflow file.", - "examples": [ - "self-hosted", - "foo", - "bar" - ] - }, - "runner_id": { - "type": [ - "integer", - "null" - ], - "description": "The ID of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)", - "examples": [ - 1 - ] - }, - "runner_name": { - "type": [ - "string", - "null" - ], - "description": "The name of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)", - "examples": [ - "my runner" - ] - }, - "runner_group_id": { - "type": [ - "integer", - "null" - ], - "description": "The ID of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)", - "examples": [ - 2 - ] - }, - "runner_group_name": { - "type": [ - "string", - "null" - ], - "description": "The name of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)", - "examples": [ - "my runner group" - ] - }, - "workflow_name": { - "type": [ - "string", - "null" - ], - "description": "The name of the workflow.", - "examples": [ - "Build" - ] - }, - "head_branch": { - "type": [ - "string", - "null" - ], - "description": "The name of the current branch.", - "examples": [ - "main" - ] } - }, - "required": [ - "id", - "node_id", - "run_id", - "run_url", - "head_sha", - "workflow_name", - "head_branch", - "name", - "url", - "html_url", - "status", - "conclusion", - "started_at", - "completed_at", - "check_run_url", - "labels", - "runner_id", - "runner_name", - "runner_group_id", - "runner_group_name", - "created_at" - ] + } } } } ], "previews": [], - "descriptionHTML": "

Gets a specific job in a workflow run.

\n

Anyone with read access to the repository can use this endpoint.

\n

If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", + "descriptionHTML": "

Lists all repositories that can access an organization variable\nthat is available to selected repositories.

\n

Authenticated users must have collaborator access to a repository to create, update, or read variables.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" + }, + { + "httpStatusCode": "409", + "description": "

Response when the visibility of the variable is not set to selected

" } ] }, { "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/jobs/{job_id}/logs", - "title": "Download job logs for a workflow run", + "verb": "put", + "requestPath": "/orgs/{org}/actions/variables/{name}/repositories", + "title": "Set selected repositories for an organization variable", "category": "actions", - "subcategory": "workflow-jobs", + "subcategory": "variables", "parameters": [ { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", "in": "path", "required": true, "schema": { @@ -32828,8 +34102,81 @@ } }, { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", + "name": "name", + "description": "

The name of the variable.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "array of integers", + "name": "selected_repository_ids", + "in": "body", + "description": "

The IDs of the repositories that can access the organization variable.

", + "isRequired": true + } + ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Variables\" organization permissions": "write" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "selected_repository_ids": [ + 64780797 + ] + }, + "parameters": { + "org": "ORG", + "name": "NAME" + } + }, + "response": { + "statusCode": "204", + "description": "

Response

" + } + } + ], + "previews": [], + "descriptionHTML": "

Replaces all repositories for an organization variable that is available\nto selected repositories. Organization variables that are available to selected\nrepositories have their visibility field set to selected.

\n

Authenticated users must have collaborator access to a repository to create, update, or read variables.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

", + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "

No Content

" + }, + { + "httpStatusCode": "409", + "description": "

Response when the visibility of the variable is not set to selected

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/orgs/{org}/actions/variables/{name}/repositories/{repository_id}", + "title": "Add selected repository to an organization variable", + "category": "actions", + "subcategory": "variables", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", "in": "path", "required": true, "schema": { @@ -32837,13 +34184,22 @@ } }, { - "name": "job_id", - "description": "

The unique identifier of the job.

", + "name": "name", + "description": "

The name of the variable.

", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" } + }, + { + "name": "repository_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "description": "" } ], "bodyParameters": [], @@ -32853,10 +34209,10 @@ "fineGrainedPat": true, "permissions": [ { - "\"Actions\" repository permissions": "read" + "\"Variables\" organization permissions": "write", + "\"Metadata\" repository permissions": "read" } - ], - "allowsPublicRead": true + ] }, "codeExamples": [ { @@ -32865,37 +34221,41 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "owner": "OWNER", - "repo": "REPO", - "job_id": "JOB_ID" + "org": "ORG", + "name": "NAME", + "repository_id": "REPOSITORY_ID" } }, "response": { - "statusCode": "302", + "statusCode": "204", "description": "

Response

" } } ], "previews": [], - "descriptionHTML": "

Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look\nfor Location: in the response header to find the URL for the download.

\n

Anyone with read access to the repository can use this endpoint.

\n

If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", + "descriptionHTML": "

Adds a repository to an organization variable that is available to selected repositories.\nOrganization variables that are available to selected repositories have their visibility field set to selected.

\n

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { - "httpStatusCode": "302", - "description": "

Found

" + "httpStatusCode": "204", + "description": "

No Content

" + }, + { + "httpStatusCode": "409", + "description": "

Response when the visibility of the variable is not set to selected

" } ] }, { "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs", - "title": "List jobs for a workflow run attempt", + "verb": "delete", + "requestPath": "/orgs/{org}/actions/variables/{name}/repositories/{repository_id}", + "title": "Remove selected repository from an organization variable", "category": "actions", - "subcategory": "workflow-jobs", + "subcategory": "variables", "parameters": [ { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", "in": "path", "required": true, "schema": { @@ -32903,8 +34263,8 @@ } }, { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", + "name": "name", + "description": "

The name of the variable.

", "in": "path", "required": true, "schema": { @@ -32912,30 +34272,91 @@ } }, { - "name": "run_id", - "description": "

The unique identifier of the workflow run.

", + "name": "repository_id", "in": "path", "required": true, "schema": { "type": "integer" + }, + "description": "" + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Variables\" organization permissions": "write", + "\"Metadata\" repository permissions": "read" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "name": "NAME", + "repository_id": "REPOSITORY_ID" + } + }, + "response": { + "statusCode": "204", + "description": "

Response

" } + } + ], + "previews": [], + "descriptionHTML": "

Removes a repository from an organization variable that is\navailable to selected repositories. Organization variables that are available to\nselected repositories have their visibility field set to selected.

\n

Authenticated users must have collaborator access to a repository to create, update, or read variables.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

", + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "

No Content

" }, { - "name": "attempt_number", - "description": "

The attempt number of the workflow run.

", + "httpStatusCode": "409", + "description": "

Response when the visibility of the variable is not set to selected

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/actions/organization-variables", + "title": "List repository organization variables", + "category": "actions", + "subcategory": "variables", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" } }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 30). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", - "default": 30 + "default": 10 } }, { @@ -32955,10 +34376,9 @@ "fineGrainedPat": true, "permissions": [ { - "\"Actions\" repository permissions": "read" + "\"Variables\" repository permissions": "read" } - ], - "allowsPublicRead": true + ] }, "codeExamples": [ { @@ -32968,9 +34388,7 @@ "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", - "repo": "REPO", - "run_id": "RUN_ID", - "attempt_number": "ATTEMPT_NUMBER" + "repo": "REPO" } }, "response": { @@ -32978,115 +34396,19 @@ "contentType": "application/json", "description": "

Response

", "example": { - "total_count": 1, - "jobs": [ + "total_count": 2, + "variables": [ { - "id": 399444496, - "run_id": 29679449, - "run_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/29679449", - "node_id": "MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==", - "head_sha": "f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0", - "url": "https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496", - "html_url": "https://github.com/octo-org/octo-repo/runs/29679449/jobs/399444496", - "status": "completed", - "conclusion": "success", - "started_at": "2020-01-20T17:42:40Z", - "completed_at": "2020-01-20T17:44:39Z", - "name": "build", - "steps": [ - { - "name": "Set up job", - "status": "completed", - "conclusion": "success", - "number": 1, - "started_at": "2020-01-20T09:42:40.000-08:00", - "completed_at": "2020-01-20T09:42:41.000-08:00" - }, - { - "name": "Run actions/checkout@v2", - "status": "completed", - "conclusion": "success", - "number": 2, - "started_at": "2020-01-20T09:42:41.000-08:00", - "completed_at": "2020-01-20T09:42:45.000-08:00" - }, - { - "name": "Set up Ruby", - "status": "completed", - "conclusion": "success", - "number": 3, - "started_at": "2020-01-20T09:42:45.000-08:00", - "completed_at": "2020-01-20T09:42:45.000-08:00" - }, - { - "name": "Run actions/cache@v3", - "status": "completed", - "conclusion": "success", - "number": 4, - "started_at": "2020-01-20T09:42:45.000-08:00", - "completed_at": "2020-01-20T09:42:48.000-08:00" - }, - { - "name": "Install Bundler", - "status": "completed", - "conclusion": "success", - "number": 5, - "started_at": "2020-01-20T09:42:48.000-08:00", - "completed_at": "2020-01-20T09:42:52.000-08:00" - }, - { - "name": "Install Gems", - "status": "completed", - "conclusion": "success", - "number": 6, - "started_at": "2020-01-20T09:42:52.000-08:00", - "completed_at": "2020-01-20T09:42:53.000-08:00" - }, - { - "name": "Run Tests", - "status": "completed", - "conclusion": "success", - "number": 7, - "started_at": "2020-01-20T09:42:53.000-08:00", - "completed_at": "2020-01-20T09:42:59.000-08:00" - }, - { - "name": "Deploy to Heroku", - "status": "completed", - "conclusion": "success", - "number": 8, - "started_at": "2020-01-20T09:42:59.000-08:00", - "completed_at": "2020-01-20T09:44:39.000-08:00" - }, - { - "name": "Post actions/cache@v3", - "status": "completed", - "conclusion": "success", - "number": 16, - "started_at": "2020-01-20T09:44:39.000-08:00", - "completed_at": "2020-01-20T09:44:39.000-08:00" - }, - { - "name": "Complete job", - "status": "completed", - "conclusion": "success", - "number": 17, - "started_at": "2020-01-20T09:44:39.000-08:00", - "completed_at": "2020-01-20T09:44:39.000-08:00" - } - ], - "check_run_url": "https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496", - "labels": [ - "self-hosted", - "foo", - "bar" - ], - "runner_id": 1, - "runner_name": "my runner", - "runner_group_id": 2, - "runner_group_name": "my runner group", - "workflow_name": "CI", - "head_branch": "main" + "name": "USERNAME", + "value": "octocat", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z" + }, + { + "name": "EMAIL", + "value": "octocat@github.com", + "created_at": "2020-01-10T10:59:22Z", + "updated_at": "2020-01-11T11:59:22Z" } ] }, @@ -33094,316 +34416,54 @@ "type": "object", "required": [ "total_count", - "jobs" + "variables" ], "properties": { "total_count": { "type": "integer" }, - "jobs": { + "variables": { "type": "array", "items": { - "title": "Job", - "description": "Information of a job execution in a workflow run", + "title": "Actions Variable", "type": "object", "properties": { - "id": { - "description": "The id of the job.", - "type": "integer", - "examples": [ - 21 - ] - }, - "run_id": { - "description": "The id of the associated workflow run.", - "type": "integer", - "examples": [ - 5 - ] - }, - "run_url": { - "type": "string", - "examples": [ - "https://api.github.com/repos/github/hello-world/actions/runs/5" - ] - }, - "run_attempt": { - "type": "integer", - "description": "Attempt number of the associated workflow run, 1 for first attempt and higher if the workflow was re-run.", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDg6Q2hlY2tSdW40" - ] - }, - "head_sha": { - "description": "The SHA of the commit that is being run.", - "type": "string", - "examples": [ - "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d" - ] - }, - "url": { + "name": { + "description": "The name of the variable.", "type": "string", "examples": [ - "https://api.github.com/repos/github/hello-world/actions/jobs/21" - ] - }, - "html_url": { - "type": [ - "string", - "null" - ], - "examples": [ - "https://github.com/github/hello-world/runs/4" + "USERNAME" ] }, - "status": { - "description": "The phase of the lifecycle that the job is currently in.", + "value": { + "description": "The value of the variable.", "type": "string", - "enum": [ - "queued", - "in_progress", - "completed", - "waiting", - "requested", - "pending" - ], - "examples": [ - "queued" - ] - }, - "conclusion": { - "description": "The outcome of the job.", - "type": [ - "string", - "null" - ], - "enum": [ - "success", - "failure", - "neutral", - "cancelled", - "skipped", - "timed_out", - "action_required", - null - ], "examples": [ - "success" + "octocat" ] }, "created_at": { - "description": "The time that the job created, in ISO 8601 format.", - "format": "date-time", - "type": "string", - "examples": [ - "2019-08-08T08:00:00-07:00" - ] - }, - "started_at": { - "description": "The time that the job started, in ISO 8601 format.", - "format": "date-time", + "description": "The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", "type": "string", - "examples": [ - "2019-08-08T08:00:00-07:00" - ] - }, - "completed_at": { - "description": "The time that the job finished, in ISO 8601 format.", "format": "date-time", - "type": [ - "string", - "null" - ], - "examples": [ - "2019-08-08T08:00:00-07:00" - ] - }, - "name": { - "description": "The name of the job.", - "type": "string", "examples": [ - "test-coverage" + "2019-01-24T22:45:36.000Z" ] }, - "steps": { - "description": "Steps in this job.", - "type": "array", - "items": { - "type": "object", - "required": [ - "name", - "status", - "conclusion", - "number" - ], - "properties": { - "status": { - "description": "The phase of the lifecycle that the job is currently in.", - "type": "string", - "enum": [ - "queued", - "in_progress", - "completed" - ], - "examples": [ - "queued" - ] - }, - "conclusion": { - "description": "The outcome of the job.", - "type": [ - "string", - "null" - ], - "examples": [ - "success" - ] - }, - "name": { - "description": "The name of the job.", - "type": "string", - "examples": [ - "test-coverage" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1 - ] - }, - "started_at": { - "description": "The time that the step started, in ISO 8601 format.", - "format": "date-time", - "type": [ - "string", - "null" - ], - "examples": [ - "2019-08-08T08:00:00-07:00" - ] - }, - "completed_at": { - "description": "The time that the job finished, in ISO 8601 format.", - "format": "date-time", - "type": [ - "string", - "null" - ], - "examples": [ - "2019-08-08T08:00:00-07:00" - ] - } - } - } - }, - "check_run_url": { + "updated_at": { + "description": "The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", "type": "string", + "format": "date-time", "examples": [ - "https://api.github.com/repos/github/hello-world/check-runs/4" - ] - }, - "labels": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Labels for the workflow job. Specified by the \"runs_on\" attribute in the action's workflow file.", - "examples": [ - "self-hosted", - "foo", - "bar" - ] - }, - "runner_id": { - "type": [ - "integer", - "null" - ], - "description": "The ID of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)", - "examples": [ - 1 - ] - }, - "runner_name": { - "type": [ - "string", - "null" - ], - "description": "The name of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)", - "examples": [ - "my runner" - ] - }, - "runner_group_id": { - "type": [ - "integer", - "null" - ], - "description": "The ID of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)", - "examples": [ - 2 - ] - }, - "runner_group_name": { - "type": [ - "string", - "null" - ], - "description": "The name of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)", - "examples": [ - "my runner group" - ] - }, - "workflow_name": { - "type": [ - "string", - "null" - ], - "description": "The name of the workflow.", - "examples": [ - "Build" - ] - }, - "head_branch": { - "type": [ - "string", - "null" - ], - "description": "The name of the current branch.", - "examples": [ - "main" + "2019-01-24T22:45:36.000Z" ] } }, "required": [ - "id", - "node_id", - "run_id", - "run_url", - "head_sha", - "workflow_name", - "head_branch", "name", - "url", - "html_url", - "status", - "conclusion", - "started_at", - "completed_at", - "check_run_url", - "labels", - "runner_id", - "runner_name", - "runner_group_id", - "runner_group_name", - "created_at" + "value", + "created_at", + "updated_at" ] } } @@ -33413,25 +34473,21 @@ } ], "previews": [], - "descriptionHTML": "

Lists jobs for a specific workflow run attempt. You can use parameters to narrow the list of results. For more information\nabout using parameters, see Parameters.

\n

Anyone with read access to the repository can use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

", + "descriptionHTML": "

Lists all organization variables shared with a repository.

\n

Authenticated users must have collaborator access to a repository to create, update, or read variables.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/jobs", - "title": "List jobs for a workflow run", + "requestPath": "/repos/{owner}/{repo}/actions/variables", + "title": "List repository variables", "category": "actions", - "subcategory": "workflow-jobs", + "subcategory": "variables", "parameters": [ { "name": "owner", @@ -33452,29 +34508,1717 @@ } }, { - "name": "run_id", - "description": "

The unique identifier of the workflow run.

", - "in": "path", - "required": true, + "name": "per_page", + "description": "

The number of results per page (max 30). For more information, see \"Using pagination in the REST API.\"

", + "in": "query", "schema": { - "type": "integer" + "type": "integer", + "default": 10 } }, { - "name": "filter", - "description": "

Filters jobs by their completed_at timestamp. latest returns jobs from the most recent execution of the workflow run. all returns all jobs for a workflow run, including from old executions of the workflow run.

", + "name": "page", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", - "required": false, "schema": { - "type": "string", - "enum": [ - "latest", - "all" - ], - "default": "latest" + "type": "integer", + "default": 1 } - }, - { + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Variables\" repository permissions": "read" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "total_count": 2, + "variables": [ + { + "name": "USERNAME", + "value": "octocat", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z" + }, + { + "name": "EMAIL", + "value": "octocat@github.com", + "created_at": "2020-01-10T10:59:22Z", + "updated_at": "2020-01-11T11:59:22Z" + } + ] + }, + "schema": { + "type": "object", + "required": [ + "total_count", + "variables" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "variables": { + "type": "array", + "items": { + "title": "Actions Variable", + "type": "object", + "properties": { + "name": { + "description": "The name of the variable.", + "type": "string", + "examples": [ + "USERNAME" + ] + }, + "value": { + "description": "The value of the variable.", + "type": "string", + "examples": [ + "octocat" + ] + }, + "created_at": { + "description": "The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "type": "string", + "format": "date-time", + "examples": [ + "2019-01-24T22:45:36.000Z" + ] + }, + "updated_at": { + "description": "The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "type": "string", + "format": "date-time", + "examples": [ + "2019-01-24T22:45:36.000Z" + ] + } + }, + "required": [ + "name", + "value", + "created_at", + "updated_at" + ] + } + } + } + } + } + } + ], + "previews": [], + "descriptionHTML": "

Lists all repository variables.

\n

Authenticated users must have collaborator access to a repository to create, update, or read variables.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/actions/variables", + "title": "Create a repository variable", + "category": "actions", + "subcategory": "variables", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "name", + "in": "body", + "description": "

The name of the variable.

", + "isRequired": true + }, + { + "type": "string", + "name": "value", + "in": "body", + "description": "

The value of the variable.

", + "isRequired": true + } + ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Variables\" repository permissions": "write" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "name": "USERNAME", + "value": "octocat" + }, + "parameters": { + "owner": "OWNER", + "repo": "REPO" + } + }, + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "

Response

", + "example": null, + "schema": { + "title": "Empty Object", + "description": "An object without any properties.", + "type": "object", + "properties": {}, + "additionalProperties": false + } + } + } + ], + "previews": [], + "descriptionHTML": "

Creates a repository variable that you can reference in a GitHub Actions workflow.

\n

Authenticated users must have collaborator access to a repository to create, update, or read variables.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "201", + "description": "

Created

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/actions/variables/{name}", + "title": "Get a repository variable", + "category": "actions", + "subcategory": "variables", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "name", + "description": "

The name of the variable.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Variables\" repository permissions": "read" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "name": "NAME" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "name": "USERNAME", + "value": "octocat", + "created_at": "2021-08-10T14:59:22Z", + "updated_at": "2022-01-10T14:59:22Z" + }, + "schema": { + "title": "Actions Variable", + "type": "object", + "properties": { + "name": { + "description": "The name of the variable.", + "type": "string", + "examples": [ + "USERNAME" + ] + }, + "value": { + "description": "The value of the variable.", + "type": "string", + "examples": [ + "octocat" + ] + }, + "created_at": { + "description": "The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "type": "string", + "format": "date-time", + "examples": [ + "2019-01-24T22:45:36.000Z" + ] + }, + "updated_at": { + "description": "The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "type": "string", + "format": "date-time", + "examples": [ + "2019-01-24T22:45:36.000Z" + ] + } + }, + "required": [ + "name", + "value", + "created_at", + "updated_at" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "

Gets a specific variable in a repository.

\n

The authenticated user must have collaborator access to the repository to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "patch", + "requestPath": "/repos/{owner}/{repo}/actions/variables/{name}", + "title": "Update a repository variable", + "category": "actions", + "subcategory": "variables", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "name", + "description": "

The name of the variable.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "name", + "in": "body", + "description": "

The name of the variable.

" + }, + { + "type": "string", + "name": "value", + "in": "body", + "description": "

The value of the variable.

" + } + ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Variables\" repository permissions": "write" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "name": "USERNAME", + "value": "octocat" + }, + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "name": "NAME" + } + }, + "response": { + "statusCode": "204", + "description": "

Response

" + } + } + ], + "previews": [], + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "

No Content

" + } + ], + "descriptionHTML": "

Updates a repository variable that you can reference in a GitHub Actions workflow.

\n

Authenticated users must have collaborator access to a repository to create, update, or read variables.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" + }, + { + "serverUrl": "https://api.github.com", + "verb": "delete", + "requestPath": "/repos/{owner}/{repo}/actions/variables/{name}", + "title": "Delete a repository variable", + "category": "actions", + "subcategory": "variables", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "name", + "description": "

The name of the variable.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Variables\" repository permissions": "write" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "name": "NAME" + } + }, + "response": { + "statusCode": "204", + "description": "

Response

" + } + } + ], + "previews": [], + "descriptionHTML": "

Deletes a repository variable using the variable name.

\n

Authenticated users must have collaborator access to a repository to create, update, or read variables.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "

No Content

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/variables", + "title": "List environment variables", + "category": "actions", + "subcategory": "variables", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "environment_name", + "in": "path", + "required": true, + "description": "

The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F.

", + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "

The number of results per page (max 30). For more information, see \"Using pagination in the REST API.\"

", + "in": "query", + "schema": { + "type": "integer", + "default": 10 + } + }, + { + "name": "page", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Environments\" repository permissions": "read" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "environment_name": "ENVIRONMENT_NAME" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "total_count": 2, + "variables": [ + { + "name": "USERNAME", + "value": "octocat", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z" + }, + { + "name": "EMAIL", + "value": "octocat@github.com", + "created_at": "2020-01-10T10:59:22Z", + "updated_at": "2020-01-11T11:59:22Z" + } + ] + }, + "schema": { + "type": "object", + "required": [ + "total_count", + "variables" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "variables": { + "type": "array", + "items": { + "title": "Actions Variable", + "type": "object", + "properties": { + "name": { + "description": "The name of the variable.", + "type": "string", + "examples": [ + "USERNAME" + ] + }, + "value": { + "description": "The value of the variable.", + "type": "string", + "examples": [ + "octocat" + ] + }, + "created_at": { + "description": "The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "type": "string", + "format": "date-time", + "examples": [ + "2019-01-24T22:45:36.000Z" + ] + }, + "updated_at": { + "description": "The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "type": "string", + "format": "date-time", + "examples": [ + "2019-01-24T22:45:36.000Z" + ] + } + }, + "required": [ + "name", + "value", + "created_at", + "updated_at" + ] + } + } + } + } + } + } + ], + "previews": [], + "descriptionHTML": "

Lists all environment variables.

\n

Authenticated users must have collaborator access to a repository to create, update, or read variables.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/variables", + "title": "Create an environment variable", + "category": "actions", + "subcategory": "variables", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "environment_name", + "in": "path", + "required": true, + "description": "

The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F.

", + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "name", + "in": "body", + "description": "

The name of the variable.

", + "isRequired": true + }, + { + "type": "string", + "name": "value", + "in": "body", + "description": "

The value of the variable.

", + "isRequired": true + } + ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Environments\" repository permissions": "write" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "name": "USERNAME", + "value": "octocat" + }, + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "environment_name": "ENVIRONMENT_NAME" + } + }, + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "

Response

", + "example": null, + "schema": { + "title": "Empty Object", + "description": "An object without any properties.", + "type": "object", + "properties": {}, + "additionalProperties": false + } + } + } + ], + "previews": [], + "descriptionHTML": "

Create an environment variable that you can reference in a GitHub Actions workflow.

\n

Authenticated users must have collaborator access to a repository to create, update, or read variables.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "201", + "description": "

Created

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}", + "title": "Get an environment variable", + "category": "actions", + "subcategory": "variables", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "environment_name", + "in": "path", + "required": true, + "description": "

The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F.

", + "schema": { + "type": "string" + } + }, + { + "name": "name", + "description": "

The name of the variable.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Environments\" repository permissions": "read" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "environment_name": "ENVIRONMENT_NAME", + "name": "NAME" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "name": "USERNAME", + "value": "octocat", + "created_at": "2021-08-10T14:59:22Z", + "updated_at": "2022-01-10T14:59:22Z" + }, + "schema": { + "title": "Actions Variable", + "type": "object", + "properties": { + "name": { + "description": "The name of the variable.", + "type": "string", + "examples": [ + "USERNAME" + ] + }, + "value": { + "description": "The value of the variable.", + "type": "string", + "examples": [ + "octocat" + ] + }, + "created_at": { + "description": "The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "type": "string", + "format": "date-time", + "examples": [ + "2019-01-24T22:45:36.000Z" + ] + }, + "updated_at": { + "description": "The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "type": "string", + "format": "date-time", + "examples": [ + "2019-01-24T22:45:36.000Z" + ] + } + }, + "required": [ + "name", + "value", + "created_at", + "updated_at" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "

Gets a specific variable in an environment.

\n

Authenticated users must have collaborator access to a repository to create, update, or read variables.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "patch", + "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}", + "title": "Update an environment variable", + "category": "actions", + "subcategory": "variables", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "name", + "description": "

The name of the variable.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "environment_name", + "in": "path", + "required": true, + "description": "

The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F.

", + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "name", + "in": "body", + "description": "

The name of the variable.

" + }, + { + "type": "string", + "name": "value", + "in": "body", + "description": "

The value of the variable.

" + } + ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Environments\" repository permissions": "write" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "name": "USERNAME", + "value": "octocat" + }, + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "name": "NAME", + "environment_name": "ENVIRONMENT_NAME" + } + }, + "response": { + "statusCode": "204", + "description": "

Response

" + } + } + ], + "previews": [], + "descriptionHTML": "

Updates an environment variable that you can reference in a GitHub Actions workflow.

\n

Authenticated users must have collaborator access to a repository to create, update, or read variables.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "

No Content

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "delete", + "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}", + "title": "Delete an environment variable", + "category": "actions", + "subcategory": "variables", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "name", + "description": "

The name of the variable.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "environment_name", + "in": "path", + "required": true, + "description": "

The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F.

", + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Environments\" repository permissions": "write" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "name": "NAME", + "environment_name": "ENVIRONMENT_NAME" + } + }, + "response": { + "statusCode": "204", + "description": "

Response

" + } + } + ], + "previews": [], + "descriptionHTML": "

Deletes an environment variable using the variable name.

\n

Authenticated users must have collaborator access to a repository to create, update, or read variables.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "

No Content

" + } + ] + } + ], + "workflow-jobs": [ + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/actions/jobs/{job_id}", + "title": "Get a job for a workflow run", + "category": "actions", + "subcategory": "workflow-jobs", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "job_id", + "description": "

The unique identifier of the job.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Actions\" repository permissions": "read" + } + ], + "allowsPublicRead": true + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "job_id": "JOB_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "id": 399444496, + "run_id": 29679449, + "run_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/29679449", + "node_id": "MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==", + "head_sha": "f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0", + "url": "https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496", + "html_url": "https://github.com/octo-org/octo-repo/runs/29679449/jobs/399444496", + "status": "completed", + "conclusion": "success", + "started_at": "2020-01-20T17:42:40Z", + "completed_at": "2020-01-20T17:44:39Z", + "name": "build", + "steps": [ + { + "name": "Set up job", + "status": "completed", + "conclusion": "success", + "number": 1, + "started_at": "2020-01-20T09:42:40.000-08:00", + "completed_at": "2020-01-20T09:42:41.000-08:00" + }, + { + "name": "Run actions/checkout@v2", + "status": "completed", + "conclusion": "success", + "number": 2, + "started_at": "2020-01-20T09:42:41.000-08:00", + "completed_at": "2020-01-20T09:42:45.000-08:00" + }, + { + "name": "Set up Ruby", + "status": "completed", + "conclusion": "success", + "number": 3, + "started_at": "2020-01-20T09:42:45.000-08:00", + "completed_at": "2020-01-20T09:42:45.000-08:00" + }, + { + "name": "Run actions/cache@v3", + "status": "completed", + "conclusion": "success", + "number": 4, + "started_at": "2020-01-20T09:42:45.000-08:00", + "completed_at": "2020-01-20T09:42:48.000-08:00" + }, + { + "name": "Install Bundler", + "status": "completed", + "conclusion": "success", + "number": 5, + "started_at": "2020-01-20T09:42:48.000-08:00", + "completed_at": "2020-01-20T09:42:52.000-08:00" + }, + { + "name": "Install Gems", + "status": "completed", + "conclusion": "success", + "number": 6, + "started_at": "2020-01-20T09:42:52.000-08:00", + "completed_at": "2020-01-20T09:42:53.000-08:00" + }, + { + "name": "Run Tests", + "status": "completed", + "conclusion": "success", + "number": 7, + "started_at": "2020-01-20T09:42:53.000-08:00", + "completed_at": "2020-01-20T09:42:59.000-08:00" + }, + { + "name": "Deploy to Heroku", + "status": "completed", + "conclusion": "success", + "number": 8, + "started_at": "2020-01-20T09:42:59.000-08:00", + "completed_at": "2020-01-20T09:44:39.000-08:00" + }, + { + "name": "Post actions/cache@v3", + "status": "completed", + "conclusion": "success", + "number": 16, + "started_at": "2020-01-20T09:44:39.000-08:00", + "completed_at": "2020-01-20T09:44:39.000-08:00" + }, + { + "name": "Complete job", + "status": "completed", + "conclusion": "success", + "number": 17, + "started_at": "2020-01-20T09:44:39.000-08:00", + "completed_at": "2020-01-20T09:44:39.000-08:00" + } + ], + "check_run_url": "https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496", + "labels": [ + "self-hosted", + "foo", + "bar" + ], + "runner_id": 1, + "runner_name": "my runner", + "runner_group_id": 2, + "runner_group_name": "my runner group", + "workflow_name": "CI", + "head_branch": "main" + }, + "schema": { + "title": "Job", + "description": "Information of a job execution in a workflow run", + "type": "object", + "properties": { + "id": { + "description": "The id of the job.", + "type": "integer", + "examples": [ + 21 + ] + }, + "run_id": { + "description": "The id of the associated workflow run.", + "type": "integer", + "examples": [ + 5 + ] + }, + "run_url": { + "type": "string", + "examples": [ + "https://api.github.com/repos/github/hello-world/actions/runs/5" + ] + }, + "run_attempt": { + "type": "integer", + "description": "Attempt number of the associated workflow run, 1 for first attempt and higher if the workflow was re-run.", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDg6Q2hlY2tSdW40" + ] + }, + "head_sha": { + "description": "The SHA of the commit that is being run.", + "type": "string", + "examples": [ + "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d" + ] + }, + "url": { + "type": "string", + "examples": [ + "https://api.github.com/repos/github/hello-world/actions/jobs/21" + ] + }, + "html_url": { + "type": [ + "string", + "null" + ], + "examples": [ + "https://github.com/github/hello-world/runs/4" + ] + }, + "status": { + "description": "The phase of the lifecycle that the job is currently in.", + "type": "string", + "enum": [ + "queued", + "in_progress", + "completed", + "waiting", + "requested", + "pending" + ], + "examples": [ + "queued" + ] + }, + "conclusion": { + "description": "The outcome of the job.", + "type": [ + "string", + "null" + ], + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "skipped", + "timed_out", + "action_required", + null + ], + "examples": [ + "success" + ] + }, + "created_at": { + "description": "The time that the job created, in ISO 8601 format.", + "format": "date-time", + "type": "string", + "examples": [ + "2019-08-08T08:00:00-07:00" + ] + }, + "started_at": { + "description": "The time that the job started, in ISO 8601 format.", + "format": "date-time", + "type": "string", + "examples": [ + "2019-08-08T08:00:00-07:00" + ] + }, + "completed_at": { + "description": "The time that the job finished, in ISO 8601 format.", + "format": "date-time", + "type": [ + "string", + "null" + ], + "examples": [ + "2019-08-08T08:00:00-07:00" + ] + }, + "name": { + "description": "The name of the job.", + "type": "string", + "examples": [ + "test-coverage" + ] + }, + "steps": { + "description": "Steps in this job.", + "type": "array", + "items": { + "type": "object", + "required": [ + "name", + "status", + "conclusion", + "number" + ], + "properties": { + "status": { + "description": "The phase of the lifecycle that the job is currently in.", + "type": "string", + "enum": [ + "queued", + "in_progress", + "completed" + ], + "examples": [ + "queued" + ] + }, + "conclusion": { + "description": "The outcome of the job.", + "type": [ + "string", + "null" + ], + "examples": [ + "success" + ] + }, + "name": { + "description": "The name of the job.", + "type": "string", + "examples": [ + "test-coverage" + ] + }, + "number": { + "type": "integer", + "examples": [ + 1 + ] + }, + "started_at": { + "description": "The time that the step started, in ISO 8601 format.", + "format": "date-time", + "type": [ + "string", + "null" + ], + "examples": [ + "2019-08-08T08:00:00-07:00" + ] + }, + "completed_at": { + "description": "The time that the job finished, in ISO 8601 format.", + "format": "date-time", + "type": [ + "string", + "null" + ], + "examples": [ + "2019-08-08T08:00:00-07:00" + ] + } + } + } + }, + "check_run_url": { + "type": "string", + "examples": [ + "https://api.github.com/repos/github/hello-world/check-runs/4" + ] + }, + "labels": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Labels for the workflow job. Specified by the \"runs_on\" attribute in the action's workflow file.", + "examples": [ + "self-hosted", + "foo", + "bar" + ] + }, + "runner_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)", + "examples": [ + 1 + ] + }, + "runner_name": { + "type": [ + "string", + "null" + ], + "description": "The name of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)", + "examples": [ + "my runner" + ] + }, + "runner_group_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)", + "examples": [ + 2 + ] + }, + "runner_group_name": { + "type": [ + "string", + "null" + ], + "description": "The name of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)", + "examples": [ + "my runner group" + ] + }, + "workflow_name": { + "type": [ + "string", + "null" + ], + "description": "The name of the workflow.", + "examples": [ + "Build" + ] + }, + "head_branch": { + "type": [ + "string", + "null" + ], + "description": "The name of the current branch.", + "examples": [ + "main" + ] + } + }, + "required": [ + "id", + "node_id", + "run_id", + "run_url", + "head_sha", + "workflow_name", + "head_branch", + "name", + "url", + "html_url", + "status", + "conclusion", + "started_at", + "completed_at", + "check_run_url", + "labels", + "runner_id", + "runner_name", + "runner_group_id", + "runner_group_name", + "created_at" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "

Gets a specific job in a workflow run.

\n

Anyone with read access to the repository can use this endpoint.

\n

If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/actions/jobs/{job_id}/logs", + "title": "Download job logs for a workflow run", + "category": "actions", + "subcategory": "workflow-jobs", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "job_id", + "description": "

The unique identifier of the job.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Actions\" repository permissions": "read" + } + ], + "allowsPublicRead": true + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "job_id": "JOB_ID" + } + }, + "response": { + "statusCode": "302", + "description": "

Response

" + } + } + ], + "previews": [], + "descriptionHTML": "

Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look\nfor Location: in the response header to find the URL for the download.

\n

Anyone with read access to the repository can use this endpoint.

\n

If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "302", + "description": "

Found

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs", + "title": "List jobs for a workflow run attempt", + "category": "actions", + "subcategory": "workflow-jobs", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "run_id", + "description": "

The unique identifier of the workflow run.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "attempt_number", + "description": "

The attempt number of the workflow run.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { "name": "per_page", "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", @@ -33514,7 +36258,8 @@ "parameters": { "owner": "OWNER", "repo": "REPO", - "run_id": "RUN_ID" + "run_id": "RUN_ID", + "attempt_number": "ATTEMPT_NUMBER" } }, "response": { @@ -33957,120 +36702,25 @@ } ], "previews": [], - "descriptionHTML": "

Lists jobs for a workflow run. You can use parameters to narrow the list of results. For more information\nabout using parameters, see Parameters.

\n

Anyone with read access to the repository can use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

", + "descriptionHTML": "

Lists jobs for a specific workflow run attempt. You can use parameters to narrow the list of results. For more information\nabout using parameters, see Parameters.

\n

Anyone with read access to the repository can use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" - } - ] - } - ], - "workflow-runs": [ - { - "serverUrl": "https://api.github.com", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/jobs/{job_id}/rerun", - "title": "Re-run a job from a workflow run", - "category": "actions", - "subcategory": "workflow-runs", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "job_id", - "description": "

The unique identifier of the job.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "boolean", - "name": "enable_debug_logging", - "in": "body", - "description": "

Whether to enable debug logging for the re-run.

", - "default": false - } - ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Actions\" repository permissions": "write" - } - ] - }, - "codeExamples": [ - { - "key": "default", - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": null, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "job_id": "JOB_ID" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": null, - "schema": { - "title": "Empty Object", - "description": "An object without any properties.", - "type": "object", - "properties": {}, - "additionalProperties": false - } - } - } - ], - "previews": [], - "descriptionHTML": "

Re-run a job and its dependent jobs in a workflow run.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Created

" }, { - "httpStatusCode": "403", - "description": "

Forbidden

" + "httpStatusCode": "404", + "description": "

Resource not found

" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runs", - "title": "List workflow runs for a repository", + "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/jobs", + "title": "List jobs for a workflow run", "category": "actions", - "subcategory": "workflow-runs", + "subcategory": "workflow-jobs", "parameters": [ { "name": "owner", @@ -34091,55 +36741,26 @@ } }, { - "name": "actor", - "description": "

Returns someone's workflow runs. Use the login for the user who created the push associated with the check suite or workflow run.

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "

Returns workflow runs associated with a branch. Use the name of the branch of the push.

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "event", - "description": "

Returns workflow run triggered by the event you specify. For example, push, pull_request or issue. For more information, see \"Events that trigger workflows.\"

", - "in": "query", - "required": false, + "name": "run_id", + "description": "

The unique identifier of the workflow run.

", + "in": "path", + "required": true, "schema": { - "type": "string" + "type": "integer" } }, { - "name": "status", - "description": "

Returns workflow runs with the check run status or conclusion that you specify. For example, a conclusion can be success or a status can be in_progress. Only GitHub Actions can set a status of waiting, pending, or requested.

", + "name": "filter", + "description": "

Filters jobs by their completed_at timestamp. latest returns jobs from the most recent execution of the workflow run. all returns all jobs for a workflow run, including from old executions of the workflow run.

", "in": "query", "required": false, "schema": { "type": "string", "enum": [ - "completed", - "action_required", - "cancelled", - "failure", - "neutral", - "skipped", - "stale", - "success", - "timed_out", - "in_progress", - "queued", - "requested", - "waiting", - "pending" - ] + "latest", + "all" + ], + "default": "latest" } }, { @@ -34159,43 +36780,6 @@ "type": "integer", "default": 1 } - }, - { - "name": "created", - "description": "

Returns workflow runs created within the given date-time range. For more information on the syntax, see \"Understanding the search syntax.\"

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "format": "date-time" - } - }, - { - "name": "exclude_pull_requests", - "description": "

If true pull requests are omitted from the response (empty array).

", - "in": "query", - "required": false, - "schema": { - "type": "boolean", - "default": false - } - }, - { - "name": "check_suite_id", - "description": "

Returns workflow runs with the check_suite_id that you specify.

", - "in": "query", - "schema": { - "type": "integer" - } - }, - { - "name": "head_sha", - "description": "

Only returns workflow runs that are associated with the specified head_sha.

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } } ], "bodyParameters": [], @@ -34218,7 +36802,8 @@ "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", - "repo": "REPO" + "repo": "REPO", + "run_id": "RUN_ID" } }, "response": { @@ -34227,134 +36812,838 @@ "description": "

Response

", "example": { "total_count": 1, - "workflow_runs": [ + "jobs": [ { - "id": 30433642, - "name": "Build", - "node_id": "MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==", - "check_suite_id": 42, - "check_suite_node_id": "MDEwOkNoZWNrU3VpdGU0Mg==", - "head_branch": "master", - "head_sha": "acb5820ced9479c074f688cc328bf03f341a511d", - "path": ".github/workflows/build.yml@main", - "run_number": 562, - "event": "push", - "display_title": "Update README.md", - "status": "queued", - "conclusion": null, - "workflow_id": 159038, - "url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642", - "html_url": "https://github.com/octo-org/octo-repo/actions/runs/30433642", - "pull_requests": [], - "created_at": "2020-01-22T19:33:08Z", - "updated_at": "2020-01-22T19:33:08Z", - "actor": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "run_attempt": 1, - "run_started_at": "2020-01-22T19:33:08Z", - "triggering_actor": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "jobs_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs", - "logs_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs", - "check_suite_url": "https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374", - "artifacts_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts", - "cancel_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel", - "rerun_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun", - "workflow_url": "https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038", - "head_commit": { - "id": "acb5820ced9479c074f688cc328bf03f341a511d", - "tree_id": "d23f6eedb1e1b9610bbc754ddb5197bfe7271223", - "message": "Create linter.yaml", - "timestamp": "2020-01-22T19:33:05Z", - "author": { - "name": "Octo Cat", - "email": "octocat@github.com" + "id": 399444496, + "run_id": 29679449, + "run_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/29679449", + "node_id": "MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==", + "head_sha": "f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0", + "url": "https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496", + "html_url": "https://github.com/octo-org/octo-repo/runs/29679449/jobs/399444496", + "status": "completed", + "conclusion": "success", + "started_at": "2020-01-20T17:42:40Z", + "completed_at": "2020-01-20T17:44:39Z", + "name": "build", + "steps": [ + { + "name": "Set up job", + "status": "completed", + "conclusion": "success", + "number": 1, + "started_at": "2020-01-20T09:42:40.000-08:00", + "completed_at": "2020-01-20T09:42:41.000-08:00" }, - "committer": { - "name": "GitHub", - "email": "noreply@github.com" - } - }, - "repository": { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "owner": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false + { + "name": "Run actions/checkout@v2", + "status": "completed", + "conclusion": "success", + "number": 2, + "started_at": "2020-01-20T09:42:41.000-08:00", + "completed_at": "2020-01-20T09:42:45.000-08:00" }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World", - "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + { + "name": "Set up Ruby", + "status": "completed", + "conclusion": "success", + "number": 3, + "started_at": "2020-01-20T09:42:45.000-08:00", + "completed_at": "2020-01-20T09:42:45.000-08:00" + }, + { + "name": "Run actions/cache@v3", + "status": "completed", + "conclusion": "success", + "number": 4, + "started_at": "2020-01-20T09:42:45.000-08:00", + "completed_at": "2020-01-20T09:42:48.000-08:00" + }, + { + "name": "Install Bundler", + "status": "completed", + "conclusion": "success", + "number": 5, + "started_at": "2020-01-20T09:42:48.000-08:00", + "completed_at": "2020-01-20T09:42:52.000-08:00" + }, + { + "name": "Install Gems", + "status": "completed", + "conclusion": "success", + "number": 6, + "started_at": "2020-01-20T09:42:52.000-08:00", + "completed_at": "2020-01-20T09:42:53.000-08:00" + }, + { + "name": "Run Tests", + "status": "completed", + "conclusion": "success", + "number": 7, + "started_at": "2020-01-20T09:42:53.000-08:00", + "completed_at": "2020-01-20T09:42:59.000-08:00" + }, + { + "name": "Deploy to Heroku", + "status": "completed", + "conclusion": "success", + "number": 8, + "started_at": "2020-01-20T09:42:59.000-08:00", + "completed_at": "2020-01-20T09:44:39.000-08:00" + }, + { + "name": "Post actions/cache@v3", + "status": "completed", + "conclusion": "success", + "number": 16, + "started_at": "2020-01-20T09:44:39.000-08:00", + "completed_at": "2020-01-20T09:44:39.000-08:00" + }, + { + "name": "Complete job", + "status": "completed", + "conclusion": "success", + "number": 17, + "started_at": "2020-01-20T09:44:39.000-08:00", + "completed_at": "2020-01-20T09:44:39.000-08:00" + } + ], + "check_run_url": "https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496", + "labels": [ + "self-hosted", + "foo", + "bar" + ], + "runner_id": 1, + "runner_name": "my runner", + "runner_group_id": 2, + "runner_group_name": "my runner group", + "workflow_name": "CI", + "head_branch": "main" + } + ] + }, + "schema": { + "type": "object", + "required": [ + "total_count", + "jobs" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "jobs": { + "type": "array", + "items": { + "title": "Job", + "description": "Information of a job execution in a workflow run", + "type": "object", + "properties": { + "id": { + "description": "The id of the job.", + "type": "integer", + "examples": [ + 21 + ] + }, + "run_id": { + "description": "The id of the associated workflow run.", + "type": "integer", + "examples": [ + 5 + ] + }, + "run_url": { + "type": "string", + "examples": [ + "https://api.github.com/repos/github/hello-world/actions/runs/5" + ] + }, + "run_attempt": { + "type": "integer", + "description": "Attempt number of the associated workflow run, 1 for first attempt and higher if the workflow was re-run.", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDg6Q2hlY2tSdW40" + ] + }, + "head_sha": { + "description": "The SHA of the commit that is being run.", + "type": "string", + "examples": [ + "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d" + ] + }, + "url": { + "type": "string", + "examples": [ + "https://api.github.com/repos/github/hello-world/actions/jobs/21" + ] + }, + "html_url": { + "type": [ + "string", + "null" + ], + "examples": [ + "https://github.com/github/hello-world/runs/4" + ] + }, + "status": { + "description": "The phase of the lifecycle that the job is currently in.", + "type": "string", + "enum": [ + "queued", + "in_progress", + "completed", + "waiting", + "requested", + "pending" + ], + "examples": [ + "queued" + ] + }, + "conclusion": { + "description": "The outcome of the job.", + "type": [ + "string", + "null" + ], + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "skipped", + "timed_out", + "action_required", + null + ], + "examples": [ + "success" + ] + }, + "created_at": { + "description": "The time that the job created, in ISO 8601 format.", + "format": "date-time", + "type": "string", + "examples": [ + "2019-08-08T08:00:00-07:00" + ] + }, + "started_at": { + "description": "The time that the job started, in ISO 8601 format.", + "format": "date-time", + "type": "string", + "examples": [ + "2019-08-08T08:00:00-07:00" + ] + }, + "completed_at": { + "description": "The time that the job finished, in ISO 8601 format.", + "format": "date-time", + "type": [ + "string", + "null" + ], + "examples": [ + "2019-08-08T08:00:00-07:00" + ] + }, + "name": { + "description": "The name of the job.", + "type": "string", + "examples": [ + "test-coverage" + ] + }, + "steps": { + "description": "Steps in this job.", + "type": "array", + "items": { + "type": "object", + "required": [ + "name", + "status", + "conclusion", + "number" + ], + "properties": { + "status": { + "description": "The phase of the lifecycle that the job is currently in.", + "type": "string", + "enum": [ + "queued", + "in_progress", + "completed" + ], + "examples": [ + "queued" + ] + }, + "conclusion": { + "description": "The outcome of the job.", + "type": [ + "string", + "null" + ], + "examples": [ + "success" + ] + }, + "name": { + "description": "The name of the job.", + "type": "string", + "examples": [ + "test-coverage" + ] + }, + "number": { + "type": "integer", + "examples": [ + 1 + ] + }, + "started_at": { + "description": "The time that the step started, in ISO 8601 format.", + "format": "date-time", + "type": [ + "string", + "null" + ], + "examples": [ + "2019-08-08T08:00:00-07:00" + ] + }, + "completed_at": { + "description": "The time that the job finished, in ISO 8601 format.", + "format": "date-time", + "type": [ + "string", + "null" + ], + "examples": [ + "2019-08-08T08:00:00-07:00" + ] + } + } + } + }, + "check_run_url": { + "type": "string", + "examples": [ + "https://api.github.com/repos/github/hello-world/check-runs/4" + ] + }, + "labels": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Labels for the workflow job. Specified by the \"runs_on\" attribute in the action's workflow file.", + "examples": [ + "self-hosted", + "foo", + "bar" + ] + }, + "runner_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)", + "examples": [ + 1 + ] + }, + "runner_name": { + "type": [ + "string", + "null" + ], + "description": "The name of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)", + "examples": [ + "my runner" + ] + }, + "runner_group_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)", + "examples": [ + 2 + ] + }, + "runner_group_name": { + "type": [ + "string", + "null" + ], + "description": "The name of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)", + "examples": [ + "my runner group" + ] + }, + "workflow_name": { + "type": [ + "string", + "null" + ], + "description": "The name of the workflow.", + "examples": [ + "Build" + ] + }, + "head_branch": { + "type": [ + "string", + "null" + ], + "description": "The name of the current branch.", + "examples": [ + "main" + ] + } + }, + "required": [ + "id", + "node_id", + "run_id", + "run_url", + "head_sha", + "workflow_name", + "head_branch", + "name", + "url", + "html_url", + "status", + "conclusion", + "started_at", + "completed_at", + "check_run_url", + "labels", + "runner_id", + "runner_name", + "runner_group_id", + "runner_group_name", + "created_at" + ] + } + } + } + } + } + } + ], + "previews": [], + "descriptionHTML": "

Lists jobs for a workflow run. You can use parameters to narrow the list of results. For more information\nabout using parameters, see Parameters.

\n

Anyone with read access to the repository can use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + } + ] + } + ], + "workflow-runs": [ + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/actions/jobs/{job_id}/rerun", + "title": "Re-run a job from a workflow run", + "category": "actions", + "subcategory": "workflow-runs", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "job_id", + "description": "

The unique identifier of the job.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [ + { + "type": "boolean", + "name": "enable_debug_logging", + "in": "body", + "description": "

Whether to enable debug logging for the re-run.

", + "default": false + } + ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Actions\" repository permissions": "write" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": null, + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "job_id": "JOB_ID" + } + }, + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "

Response

", + "example": null, + "schema": { + "title": "Empty Object", + "description": "An object without any properties.", + "type": "object", + "properties": {}, + "additionalProperties": false + } + } + } + ], + "previews": [], + "descriptionHTML": "

Re-run a job and its dependent jobs in a workflow run.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "201", + "description": "

Created

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/actions/runs", + "title": "List workflow runs for a repository", + "category": "actions", + "subcategory": "workflow-runs", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "actor", + "description": "

Returns someone's workflow runs. Use the login for the user who created the push associated with the check suite or workflow run.

", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "branch", + "description": "

Returns workflow runs associated with a branch. Use the name of the branch of the push.

", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "event", + "description": "

Returns workflow run triggered by the event you specify. For example, push, pull_request or issue. For more information, see \"Events that trigger workflows.\"

", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "status", + "description": "

Returns workflow runs with the check run status or conclusion that you specify. For example, a conclusion can be success or a status can be in_progress. Only GitHub Actions can set a status of waiting, pending, or requested.

", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "completed", + "action_required", + "cancelled", + "failure", + "neutral", + "skipped", + "stale", + "success", + "timed_out", + "in_progress", + "queued", + "requested", + "waiting", + "pending" + ] + } + }, + { + "name": "per_page", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "created", + "description": "

Returns workflow runs created within the given date-time range. For more information on the syntax, see \"Understanding the search syntax.\"

", + "in": "query", + "required": false, + "schema": { + "type": "string", + "format": "date-time" + } + }, + { + "name": "exclude_pull_requests", + "description": "

If true pull requests are omitted from the response (empty array).

", + "in": "query", + "required": false, + "schema": { + "type": "boolean", + "default": false + } + }, + { + "name": "check_suite_id", + "description": "

Returns workflow runs with the check_suite_id that you specify.

", + "in": "query", + "schema": { + "type": "integer" + } + }, + { + "name": "head_sha", + "description": "

Only returns workflow runs that are associated with the specified head_sha.

", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Actions\" repository permissions": "read" + } + ], + "allowsPublicRead": true + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "total_count": 1, + "workflow_runs": [ + { + "id": 30433642, + "name": "Build", + "node_id": "MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==", + "check_suite_id": 42, + "check_suite_node_id": "MDEwOkNoZWNrU3VpdGU0Mg==", + "head_branch": "master", + "head_sha": "acb5820ced9479c074f688cc328bf03f341a511d", + "path": ".github/workflows/build.yml@main", + "run_number": 562, + "event": "push", + "display_title": "Update README.md", + "status": "queued", + "conclusion": null, + "workflow_id": 159038, + "url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642", + "html_url": "https://github.com/octo-org/octo-repo/actions/runs/30433642", + "pull_requests": [], + "created_at": "2020-01-22T19:33:08Z", + "updated_at": "2020-01-22T19:33:08Z", + "actor": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "run_attempt": 1, + "run_started_at": "2020-01-22T19:33:08Z", + "triggering_actor": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "jobs_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs", + "logs_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs", + "check_suite_url": "https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374", + "artifacts_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts", + "cancel_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel", + "rerun_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun", + "workflow_url": "https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038", + "head_commit": { + "id": "acb5820ced9479c074f688cc328bf03f341a511d", + "tree_id": "d23f6eedb1e1b9610bbc754ddb5197bfe7271223", + "message": "Create linter.yaml", + "timestamp": "2020-01-22T19:33:05Z", + "author": { + "name": "Octo Cat", + "email": "octocat@github.com" + }, + "committer": { + "name": "GitHub", + "email": "noreply@github.com" + } + }, + "repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", @@ -45262,13 +48551,13 @@ } ], "previews": [], - "descriptionHTML": "

Approve or reject pending deployments that are waiting on approval by a required reviewer.

\n

Required reviewers with read access to the repository contents and deployments can use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Approve or reject pending deployments that are waiting on approval by a required reviewer.

\n

Required reviewers with read access to the repository contents and deployments can use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" }, { "serverUrl": "https://api.github.com", @@ -49156,13 +52445,13 @@ } ], "previews": [], - "descriptionHTML": "

Disables a workflow and sets the state of the workflow to disabled_manually. You can replace workflow_id with the workflow file name. For example, you could use main.yaml.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ] + ], + "descriptionHTML": "

Disables a workflow and sets the state of the workflow to disabled_manually. You can replace workflow_id with the workflow file name. For example, you could use main.yaml.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" }, { "serverUrl": "https://api.github.com", @@ -52464,6 +55753,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -56288,6 +59601,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -60106,6 +63443,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -63922,6 +67283,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -67724,6 +71109,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -71550,6 +74959,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -75352,6 +78785,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -76157,13 +79614,13 @@ } ], "previews": [], - "descriptionHTML": "

Note

\n

\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.

\n
", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Note

\n

\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.

\n
" }, { "serverUrl": "https://api.github.com", @@ -79165,6 +82622,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -82978,6 +86459,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -86542,13 +90047,13 @@ } ], "previews": [], - "descriptionHTML": "

Marks a thread as \"done.\" Marking a thread as \"done\" is equivalent to marking a notification in your notification inbox on GitHub Enterprise Cloud as done: https://github.com/notifications.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No content

" } - ] + ], + "descriptionHTML": "

Marks a thread as \"done.\" Marking a thread as \"done\" is equivalent to marking a notification in your notification inbox on GitHub Enterprise Cloud as done: https://github.com/notifications.

" }, { "serverUrl": "https://api.github.com", @@ -93678,13 +97183,13 @@ } ], "previews": [], - "descriptionHTML": "

Lists repositories a user has starred.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Lists repositories a user has starred.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n" } ], "watching": [ @@ -96931,13 +100436,13 @@ } ], "previews": [], - "descriptionHTML": "

Sets the announcement banner to display for the organization.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Sets the announcement banner to display for the organization.

" }, { "serverUrl": "https://api.github.com", @@ -118560,13 +122065,13 @@ } ], "previews": [], - "descriptionHTML": "

Gets the summary of the free and paid GitHub Actions minutes used.

\n

Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see \"Managing billing for GitHub Actions\".

\n

OAuth app tokens and personal access tokens (classic) need the user scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Gets the summary of the free and paid GitHub Actions minutes used.

\n

Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see \"Managing billing for GitHub Actions\".

\n

OAuth app tokens and personal access tokens (classic) need the user scope to use this endpoint.

" }, { "serverUrl": "https://api.github.com", @@ -138642,13 +142147,13 @@ } ], "previews": [], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ] + ], + "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

" }, { "serverUrl": "https://api.github.com", @@ -143048,7 +146553,6 @@ } ], "previews": [], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Removes the ability of a team to push to this branch. You can also remove push access for child teams.

", "statusCodes": [ { "httpStatusCode": "200", @@ -143058,7 +146562,8 @@ "httpStatusCode": "422", "description": "

Validation failed, or the endpoint has been spammed.

" } - ] + ], + "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Removes the ability of a team to push to this branch. You can also remove push access for child teams.

" }, { "serverUrl": "https://api.github.com", @@ -152836,13 +156341,13 @@ } ], "previews": [], - "descriptionHTML": "

Updates a check run for a specific commit in a repository.

\n

Note

\n

\nThe endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

\n
\n

OAuth apps and personal access tokens (classic) cannot use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Updates a check run for a specific commit in a repository.

\n

Note

\n

\nThe endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

\n
\n

OAuth apps and personal access tokens (classic) cannot use this endpoint.

" }, { "serverUrl": "https://api.github.com", @@ -185779,7 +189284,6 @@ } ], "previews": [], - "descriptionHTML": "

Updates a code security configuration in an enterprise.

\n

The authenticated user must be an administrator of the enterprise in order to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -185801,7 +189305,8 @@ "httpStatusCode": "409", "description": "

Conflict

" } - ] + ], + "descriptionHTML": "

Updates a code security configuration in an enterprise.

\n

The authenticated user must be an administrator of the enterprise in order to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

" }, { "serverUrl": "https://api.github.com", @@ -189846,7 +193351,6 @@ } ], "previews": [], - "descriptionHTML": "

Updates a code security configuration in an organization.

\n

The authenticated user must be an administrator or security manager for the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -189856,7 +193360,8 @@ "httpStatusCode": "204", "description": "

Response when no new updates are made

" } - ] + ], + "descriptionHTML": "

Updates a code security configuration in an organization.

\n

The authenticated user must be an administrator or security manager for the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.

" }, { "serverUrl": "https://api.github.com", @@ -229747,13 +233252,13 @@ } ], "previews": [], - "descriptionHTML": "

Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.

\n

If the repository is private, OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.

\n

If the repository is private, OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" }, { "serverUrl": "https://api.github.com", @@ -255825,7 +259330,7 @@ } ], "previews": [], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Lists all Copilot seats currently being billed for across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription.

\n

Users with access through multiple organizations or enterprise teams will only be counted toward total_seats once.

\n

For each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the seats array.\nEach seat object contains information about the assigned user's most recent Copilot activity. Users must have\ntelemetry enabled in their IDE for Copilot in the IDE activity to be reflected in last_activity_at. For more information about activity data,\nsee \"Reviewing user activity data for Copilot in your organization.\"

\n

Only enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams.

\n

Personal access tokens (classic) need either the manage_billing:copilot or read:enterprise scopes to use this endpoint.

", + "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Lists all Copilot seats currently being billed for across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription.

\n

Users with access through multiple organizations or enterprise teams will only be counted toward total_seats once.

\n

For each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the seats array.\nEach seat object contains information about the assigned user's most recent Copilot activity. Users must have\ntelemetry enabled in their IDE for Copilot in the IDE activity to be reflected in last_activity_at. For more information about activity data,\nsee Metrics data properties for GitHub Copilot.

\n

Only enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams.

\n

Personal access tokens (classic) need either the manage_billing:copilot or read:enterprise scopes to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -257636,7 +261141,7 @@ } ], "previews": [], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Lists all Copilot seats for which an organization with a Copilot Business or Copilot Enterprise subscription is currently being billed.\nOnly organization owners can view assigned seats.

\n

Each seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in last_activity_at.\nFor more information about activity data, see \"Reviewing user activity data for Copilot in your organization.\"

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or read:org scopes to use this endpoint.

", + "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Lists all Copilot seats for which an organization with a Copilot Business or Copilot Enterprise subscription is currently being billed.\nOnly organization owners can view assigned seats.

\n

Each seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in last_activity_at.\nFor more information about activity data, see Metrics data properties for GitHub Copilot.

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or read:org scopes to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -258835,7 +262340,7 @@ } ], "previews": [], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Gets the GitHub Copilot seat details for a member of an organization who currently has access to GitHub Copilot.

\n

The seat object contains information about the user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in last_activity_at.\nFor more information about activity data, see \"Reviewing user activity data for Copilot in your organization.\"

\n

Only organization owners can view Copilot seat assignment details for members of their organization.

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or read:org scopes to use this endpoint.

", + "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Gets the GitHub Copilot seat details for a member of an organization who currently has access to GitHub Copilot.

\n

The seat object contains information about the user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in last_activity_at.\nFor more information about activity data, see Metrics data properties for GitHub Copilot.

\n

Only organization owners can view Copilot seat assignment details for members of their organization.

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or read:org scopes to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -267246,13 +270751,13 @@ } ], "previews": [], - "descriptionHTML": "

Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" }, { "serverUrl": "https://api.github.com", @@ -268607,13 +272112,13 @@ } ], "previews": [], - "descriptionHTML": "

Lists all repositories that have been selected when the visibility\nfor repository access to a secret is set to selected.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Lists all repositories that have been selected when the visibility\nfor repository access to a secret is set to selected.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" }, { "serverUrl": "https://api.github.com", @@ -270489,13 +273994,13 @@ } ], "previews": [], - "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "" }, { "serverUrl": "https://api.github.com", @@ -271763,13 +275268,13 @@ } ], "previews": [], - "descriptionHTML": "

Simple filtering of deployments is available via query parameters:

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Simple filtering of deployments is available via query parameters:

" }, { "serverUrl": "https://api.github.com", @@ -275909,13 +279414,13 @@ } ], "previews": [], - "descriptionHTML": "

Note

\n

\nTo get information about name patterns that branches must match in order to deploy to this environment, see \"Get a deployment branch policy.\"

\n
\n

Anyone with read access to the repository can use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Note

\n

\nTo get information about name patterns that branches must match in order to deploy to this environment, see \"Get a deployment branch policy.\"

\n
\n

Anyone with read access to the repository can use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

" }, { "serverUrl": "https://api.github.com", @@ -282931,13 +286436,13 @@ } ], "previews": [], - "descriptionHTML": "

Gets the audit log for an enterprise.

\n

This endpoint has a rate limit of 1,750 queries per hour per user and IP address. If your integration receives a rate limit error (typically a 403 or 429 response), it should wait before making another request to the GitHub API. For more information, see \"Rate limits for the REST API\" and \"Best practices for integrators.\"

\n

The authenticated user must be an enterprise admin to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the read:audit_log scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Gets the audit log for an enterprise.

\n

This endpoint has a rate limit of 1,750 queries per hour per user and IP address. If your integration receives a rate limit error (typically a 403 or 429 response), it should wait before making another request to the GitHub API. For more information, see \"Rate limits for the REST API\" and \"Best practices for integrators.\"

\n

The authenticated user must be an enterprise admin to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the read:audit_log scope to use this endpoint.

" }, { "serverUrl": "https://api.github.com", @@ -283003,13 +286508,13 @@ } ], "previews": [], - "descriptionHTML": "

Retrieves the audit log streaming public key for encrypting secrets.

\n

When using this endpoint, you must encrypt the credentials following the same encryption steps as outlined in the guide on encrypting secrets. See \"Encrypting secrets for the REST API.\"

", "statusCodes": [ { "httpStatusCode": "200", "description": "

The stream key for the audit log streaming configuration was retrieved successfully.

" } - ] + ], + "descriptionHTML": "

Retrieves the audit log streaming public key for encrypting secrets.

\n

When using this endpoint, you must encrypt the credentials following the same encryption steps as outlined in the guide on encrypting secrets. See \"Encrypting secrets for the REST API.\"

" }, { "serverUrl": "https://api.github.com", @@ -283574,13 +287079,13 @@ } ], "previews": [], - "descriptionHTML": "

Creates an audit log streaming configuration for any of the supported streaming endpoints: Azure Blob Storage, Azure Event Hubs, Amazon S3, Splunk, Google Cloud Storage, Datadog.

\n

When using this endpoint, you must encrypt the credentials following the same encryption steps as outlined in the guide on encrypting secrets. See \"Encrypting secrets for the REST API.\"

", "statusCodes": [ { "httpStatusCode": "200", "description": "

The audit log stream configuration was created successfully.

" } - ] + ], + "descriptionHTML": "

Creates an audit log streaming configuration for any of the supported streaming endpoints: Azure Blob Storage, Azure Event Hubs, Amazon S3, Splunk, Google Cloud Storage, Datadog.

\n

When using this endpoint, you must encrypt the credentials following the same encryption steps as outlined in the guide on encrypting secrets. See \"Encrypting secrets for the REST API.\"

" }, { "serverUrl": "https://api.github.com", @@ -283686,13 +287191,13 @@ } ], "previews": [], - "descriptionHTML": "

Lists one audit log stream configuration via a stream ID.

\n

When using this endpoint, you must encrypt the credentials following the same encryption steps as outlined in the guide on encrypting secrets. See \"Encrypting secrets for the REST API.\"

", "statusCodes": [ { "httpStatusCode": "200", "description": "

Lists one audit log stream configuration via stream ID.

" } - ] + ], + "descriptionHTML": "

Lists one audit log stream configuration via a stream ID.

\n

When using this endpoint, you must encrypt the credentials following the same encryption steps as outlined in the guide on encrypting secrets. See \"Encrypting secrets for the REST API.\"

" }, { "serverUrl": "https://api.github.com", @@ -288946,13 +292451,13 @@ } ], "previews": [], - "descriptionHTML": "

Gets a hosted compute network settings resource configured for an enterprise.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Gets a hosted compute network settings resource configured for an enterprise.

" } ], "organization-installations": [ @@ -289064,13 +292569,13 @@ } ], "previews": [], - "descriptionHTML": "

List the organizations owned by the enterprise, intended for use by GitHub Apps that are managing applications across the enterprise.

\n

This API can only be called by a GitHub App installed on the enterprise that owns the organization.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

A list of organizations owned by the enterprise on which the authenticated GitHub App is installed.

" } - ] + ], + "descriptionHTML": "

List the organizations owned by the enterprise, intended for use by GitHub Apps that are managing applications across the enterprise.

\n

This API can only be called by a GitHub App installed on the enterprise that owns the organization.

" }, { "serverUrl": "https://api.github.com", @@ -326676,6 +330181,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -329891,6 +333420,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -333028,6 +336581,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -336098,6 +339675,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -339134,6 +342735,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -342243,6 +345868,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -345643,6 +349292,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -349048,6 +352721,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -352076,6 +355773,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -359826,6 +363547,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -364603,6 +368348,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -374244,100 +378013,12888 @@ "additionalProperties": { "type": "string" }, - "example": { - "issues": "read", - "deployments": "write" + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer", + "examples": [ + 5 + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + ] + }, + "dismissed_review": { + "type": "object", + "properties": { + "state": { + "type": "string" + }, + "review_id": { + "type": "integer" + }, + "dismissal_message": { + "type": [ + "string", + "null" + ] + }, + "dismissal_commit_id": { + "type": "string" + } + }, + "required": [ + "state", + "review_id", + "dismissal_message" + ] + } + }, + "required": [ + "dismissed_review", + "id", + "node_id", + "url", + "actor", + "event", + "commit_id", + "commit_url", + "created_at", + "performed_via_github_app" + ] + }, + { + "title": "Locked Issue Event", + "description": "Locked Issue Event", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "actor": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "event": { + "type": "string" + }, + "commit_id": { + "type": [ + "string", + "null" + ] + }, + "commit_url": { + "type": [ + "string", + "null" + ] + }, + "created_at": { + "type": "string" + }, + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer", + "examples": [ + 5 + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + ] + }, + "lock_reason": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"off-topic\"" + ] + } + }, + "required": [ + "lock_reason", + "id", + "node_id", + "url", + "actor", + "event", + "commit_id", + "commit_url", + "created_at", + "performed_via_github_app" + ] + }, + { + "title": "Added to Project Issue Event", + "description": "Added to Project Issue Event", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "actor": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "event": { + "type": "string" + }, + "commit_id": { + "type": [ + "string", + "null" + ] + }, + "commit_url": { + "type": [ + "string", + "null" + ] + }, + "created_at": { + "type": "string" + }, + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer", + "examples": [ + 5 + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + ] + }, + "project_card": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + }, + "project_id": { + "type": "integer" + }, + "project_url": { + "type": "string", + "format": "uri" + }, + "column_name": { + "type": "string" + }, + "previous_column_name": { + "type": "string" + } + }, + "required": [ + "id", + "url", + "project_id", + "project_url", + "column_name" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "actor", + "event", + "commit_id", + "commit_url", + "created_at", + "performed_via_github_app" + ] + }, + { + "title": "Moved Column in Project Issue Event", + "description": "Moved Column in Project Issue Event", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "actor": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "event": { + "type": "string" + }, + "commit_id": { + "type": [ + "string", + "null" + ] + }, + "commit_url": { + "type": [ + "string", + "null" + ] + }, + "created_at": { + "type": "string" + }, + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer", + "examples": [ + 5 + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + ] + }, + "project_card": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + }, + "project_id": { + "type": "integer" + }, + "project_url": { + "type": "string", + "format": "uri" + }, + "column_name": { + "type": "string" + }, + "previous_column_name": { + "type": "string" + } + }, + "required": [ + "id", + "url", + "project_id", + "project_url", + "column_name" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "actor", + "event", + "commit_id", + "commit_url", + "created_at", + "performed_via_github_app" + ] + }, + { + "title": "Removed from Project Issue Event", + "description": "Removed from Project Issue Event", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "actor": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "event": { + "type": "string" + }, + "commit_id": { + "type": [ + "string", + "null" + ] + }, + "commit_url": { + "type": [ + "string", + "null" + ] + }, + "created_at": { + "type": "string" + }, + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer", + "examples": [ + 5 + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + ] + }, + "project_card": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + }, + "project_id": { + "type": "integer" + }, + "project_url": { + "type": "string", + "format": "uri" + }, + "column_name": { + "type": "string" + }, + "previous_column_name": { + "type": "string" + } + }, + "required": [ + "id", + "url", + "project_id", + "project_url", + "column_name" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "actor", + "event", + "commit_id", + "commit_url", + "created_at", + "performed_via_github_app" + ] + }, + { + "title": "Converted Note to Issue Issue Event", + "description": "Converted Note to Issue Issue Event", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "actor": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "event": { + "type": "string" + }, + "commit_id": { + "type": [ + "string", + "null" + ] + }, + "commit_url": { + "type": [ + "string", + "null" + ] + }, + "created_at": { + "type": "string" + }, + "performed_via_github_app": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer", + "examples": [ + 5 + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + }, + "project_card": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + }, + "project_id": { + "type": "integer" + }, + "project_url": { + "type": "string", + "format": "uri" + }, + "column_name": { + "type": "string" + }, + "previous_column_name": { + "type": "string" + } + }, + "required": [ + "id", + "url", + "project_id", + "project_url", + "column_name" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "actor", + "event", + "commit_id", + "commit_url", + "created_at", + "performed_via_github_app" + ] + } + ] + } + } + } + } + ], + "previews": [], + "descriptionHTML": "

Lists all events for an issue.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "410", + "description": "

Gone

" + } + ] + } + ], + "issue-dependencies": [ + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_by", + "title": "List dependencies an issue is blocked by", + "category": "issues", + "subcategory": "issue-dependencies", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "issue_number", + "description": "

The number that identifies the issue.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "per_page", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Issues\" repository permissions": "read" + } + ], + "allowsPublicRead": true + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "issue_number": "ISSUE_NUMBER" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": [ + { + "id": 1, + "node_id": "MDU6SXNzdWUx", + "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", + "repository_url": "https://api.github.com/repos/octocat/Hello-World", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", + "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events", + "html_url": "https://github.com/octocat/Hello-World/issues/1347", + "number": 1347, + "state": "open", + "title": "Found a bug", + "body": "I'm having a problem with this.", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "labels": [ + { + "id": 208045946, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", + "name": "bug", + "description": "Something isn't working", + "color": "f29513", + "default": true + } + ], + "assignee": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "assignees": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + ], + "milestone": { + "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", + "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", + "id": 1002604, + "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", + "number": 1, + "state": "open", + "title": "v1.0", + "description": "Tracking milestone for version 1.0", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "open_issues": 4, + "closed_issues": 8, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z", + "closed_at": "2013-02-12T13:22:01Z", + "due_on": "2012-10-09T23:39:01Z" + }, + "locked": true, + "active_lock_reason": "too heated", + "comments": 0, + "pull_request": { + "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", + "html_url": "https://github.com/octocat/Hello-World/pull/1347", + "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", + "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch" + }, + "closed_at": null, + "created_at": "2011-04-22T13:33:48Z", + "updated_at": "2011-04-22T13:33:48Z", + "closed_by": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "author_association": "COLLABORATOR", + "state_reason": "completed" + } + ], + "schema": { + "type": "array", + "items": { + "title": "Issue", + "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repositories/42/issues/1" + ] + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "labels_url": { + "type": "string" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "number": { + "description": "Number uniquely identifying the issue within its repository", + "type": "integer", + "examples": [ + 42 + ] + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "examples": [ + "open" + ] + }, + "state_reason": { + "description": "The reason for the current state", + "type": [ + "string", + "null" + ], + "enum": [ + "completed", + "reopened", + "not_planned", + "duplicate", + null + ], + "examples": [ + "not_planned" + ] + }, + "title": { + "description": "Title of the issue", + "type": "string", + "examples": [ + "Widget creation fails in Safari on OS X 10.8" + ] + }, + "body": { + "description": "Contents of the issue", + "type": [ + "string", + "null" + ], + "examples": [ + "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?" + ] + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "labels": { + "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", + "type": "array", + "items": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "name": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "color": { + "type": [ + "string", + "null" + ] + }, + "default": { + "type": "boolean" + } + } + } + ] + }, + "examples": [ + "bug", + "registration" + ] + }, + "assignee": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "assignees": { + "type": [ + "array", + "null" + ], + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "milestone": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/milestones/v1.0" + ] + }, + "labels_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1002604 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDk6TWlsZXN0b25lMTAwMjYwNA==" + ] + }, + "number": { + "description": "The number of the milestone.", + "type": "integer", + "examples": [ + 42 + ] + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open", + "examples": [ + "open" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string", + "examples": [ + "v1.0" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "Tracking milestone for version 1.0" + ] + }, + "creator": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 4 + ] + }, + "closed_issues": { + "type": "integer", + "examples": [ + 8 + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-10T20:09:31Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2014-03-03T18:58:10Z" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2013-02-12T13:22:01Z" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2012-10-09T23:39:01Z" + ] + } + }, + "required": [ + "closed_issues", + "creator", + "description", + "due_on", + "closed_at", + "id", + "node_id", + "labels_url", + "html_url", + "number", + "open_issues", + "state", + "title", + "url", + "created_at", + "updated_at" + ] + } + ] + }, + "locked": { + "type": "boolean" + }, + "active_lock_reason": { + "type": [ + "string", + "null" + ] + }, + "comments": { + "type": "integer" + }, + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "diff_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "patch_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "closed_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "body_html": { + "type": "string" + }, + "body_text": { + "type": "string" + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "type": "string" + } + } + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer", + "examples": [ + 5 + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + ] + }, + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ], + "examples": [ + "OWNER" + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + } + }, + "required": [ + "assignee", + "closed_at", + "comments", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "labels", + "labels_url", + "milestone", + "number", + "repository_url", + "state", + "locked", + "title", + "url", + "user", + "author_association", + "created_at", + "updated_at" + ] + } + } + } + } + ], + "previews": [], + "descriptionHTML": "

You can use the REST API to list the dependencies an issue is blocked by.

\n

This endpoint supports the following custom media types. For more information, see Media types.

\n", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "301", + "description": "

Moved permanently

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "410", + "description": "

Gone

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_by", + "title": "Add a dependency an issue is blocked by", + "category": "issues", + "subcategory": "issue-dependencies", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "issue_number", + "description": "

The number that identifies the issue.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [ + { + "type": "integer", + "name": "issue_id", + "in": "body", + "description": "

The id of the issue that blocks the current issue

", + "isRequired": true + } + ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Issues\" repository permissions": "write" + } + ], + "allowsPublicRead": true + }, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "issue_id": 1 + }, + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "issue_number": "ISSUE_NUMBER" + } + }, + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "

Response

", + "example": { + "id": 1, + "node_id": "MDU6SXNzdWUx", + "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", + "repository_url": "https://api.github.com/repos/octocat/Hello-World", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", + "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events", + "html_url": "https://github.com/octocat/Hello-World/issues/1347", + "number": 1347, + "state": "open", + "title": "Found a bug", + "body": "I'm having a problem with this.", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "labels": [ + { + "id": 208045946, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", + "name": "bug", + "description": "Something isn't working", + "color": "f29513", + "default": true + } + ], + "assignee": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "assignees": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + ], + "milestone": { + "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", + "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", + "id": 1002604, + "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", + "number": 1, + "state": "open", + "title": "v1.0", + "description": "Tracking milestone for version 1.0", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "open_issues": 4, + "closed_issues": 8, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z", + "closed_at": "2013-02-12T13:22:01Z", + "due_on": "2012-10-09T23:39:01Z" + }, + "locked": true, + "active_lock_reason": "too heated", + "comments": 0, + "pull_request": { + "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", + "html_url": "https://github.com/octocat/Hello-World/pull/1347", + "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", + "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch" + }, + "closed_at": null, + "created_at": "2011-04-22T13:33:48Z", + "updated_at": "2011-04-22T13:33:48Z", + "closed_by": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "author_association": "COLLABORATOR", + "state_reason": "completed" + }, + "schema": { + "title": "Issue", + "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repositories/42/issues/1" + ] + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "labels_url": { + "type": "string" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "number": { + "description": "Number uniquely identifying the issue within its repository", + "type": "integer", + "examples": [ + 42 + ] + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "examples": [ + "open" + ] + }, + "state_reason": { + "description": "The reason for the current state", + "type": [ + "string", + "null" + ], + "enum": [ + "completed", + "reopened", + "not_planned", + "duplicate", + null + ], + "examples": [ + "not_planned" + ] + }, + "title": { + "description": "Title of the issue", + "type": "string", + "examples": [ + "Widget creation fails in Safari on OS X 10.8" + ] + }, + "body": { + "description": "Contents of the issue", + "type": [ + "string", + "null" + ], + "examples": [ + "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?" + ] + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "labels": { + "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", + "type": "array", + "items": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "name": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "color": { + "type": [ + "string", + "null" + ] + }, + "default": { + "type": "boolean" + } + } + } + ] + }, + "examples": [ + "bug", + "registration" + ] + }, + "assignee": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "assignees": { + "type": [ + "array", + "null" + ], + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "milestone": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/milestones/v1.0" + ] + }, + "labels_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1002604 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDk6TWlsZXN0b25lMTAwMjYwNA==" + ] + }, + "number": { + "description": "The number of the milestone.", + "type": "integer", + "examples": [ + 42 + ] + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open", + "examples": [ + "open" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string", + "examples": [ + "v1.0" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "Tracking milestone for version 1.0" + ] + }, + "creator": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 4 + ] + }, + "closed_issues": { + "type": "integer", + "examples": [ + 8 + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-10T20:09:31Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2014-03-03T18:58:10Z" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2013-02-12T13:22:01Z" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2012-10-09T23:39:01Z" + ] + } + }, + "required": [ + "closed_issues", + "creator", + "description", + "due_on", + "closed_at", + "id", + "node_id", + "labels_url", + "html_url", + "number", + "open_issues", + "state", + "title", + "url", + "created_at", + "updated_at" + ] + } + ] + }, + "locked": { + "type": "boolean" + }, + "active_lock_reason": { + "type": [ + "string", + "null" + ] + }, + "comments": { + "type": "integer" + }, + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "diff_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "patch_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "closed_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "body_html": { + "type": "string" + }, + "body_text": { + "type": "string" + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "type": "string" + } + } + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer", + "examples": [ + 5 + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + ] + }, + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ], + "examples": [ + "OWNER" + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + } + }, + "required": [ + "assignee", + "closed_at", + "comments", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "labels", + "labels_url", + "milestone", + "number", + "repository_url", + "state", + "locked", + "title", + "url", + "user", + "author_association", + "created_at", + "updated_at" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "

You can use the REST API to add a 'blocked by' relationship to an issue.

\n

Creating content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see Rate limits for the API\nand Best practices for using the REST API.

\n

This endpoint supports the following custom media types. For more information, see Media types.

\n", + "statusCodes": [ + { + "httpStatusCode": "201", + "description": "

Created

" + }, + { + "httpStatusCode": "301", + "description": "

Moved permanently

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "410", + "description": "

Gone

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "delete", + "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_by/{issue_id}", + "title": "Remove dependency an issue is blocked by", + "category": "issues", + "subcategory": "issue-dependencies", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "issue_number", + "description": "

The number that identifies the issue.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "issue_id", + "in": "path", + "description": "

The id of the blocking issue to remove as a dependency

", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Issues\" repository permissions": "write" + } + ], + "allowsPublicRead": true + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "issue_number": "ISSUE_NUMBER", + "issue_id": "ISSUE_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "id": 1, + "node_id": "MDU6SXNzdWUx", + "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", + "repository_url": "https://api.github.com/repos/octocat/Hello-World", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", + "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events", + "html_url": "https://github.com/octocat/Hello-World/issues/1347", + "number": 1347, + "state": "open", + "title": "Found a bug", + "body": "I'm having a problem with this.", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "labels": [ + { + "id": 208045946, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", + "name": "bug", + "description": "Something isn't working", + "color": "f29513", + "default": true + } + ], + "assignee": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "assignees": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + ], + "milestone": { + "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", + "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", + "id": 1002604, + "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", + "number": 1, + "state": "open", + "title": "v1.0", + "description": "Tracking milestone for version 1.0", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "open_issues": 4, + "closed_issues": 8, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z", + "closed_at": "2013-02-12T13:22:01Z", + "due_on": "2012-10-09T23:39:01Z" + }, + "locked": true, + "active_lock_reason": "too heated", + "comments": 0, + "pull_request": { + "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", + "html_url": "https://github.com/octocat/Hello-World/pull/1347", + "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", + "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch" + }, + "closed_at": null, + "created_at": "2011-04-22T13:33:48Z", + "updated_at": "2011-04-22T13:33:48Z", + "closed_by": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "author_association": "COLLABORATOR", + "state_reason": "completed" + }, + "schema": { + "title": "Issue", + "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repositories/42/issues/1" + ] + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "labels_url": { + "type": "string" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "number": { + "description": "Number uniquely identifying the issue within its repository", + "type": "integer", + "examples": [ + 42 + ] + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "examples": [ + "open" + ] + }, + "state_reason": { + "description": "The reason for the current state", + "type": [ + "string", + "null" + ], + "enum": [ + "completed", + "reopened", + "not_planned", + "duplicate", + null + ], + "examples": [ + "not_planned" + ] + }, + "title": { + "description": "Title of the issue", + "type": "string", + "examples": [ + "Widget creation fails in Safari on OS X 10.8" + ] + }, + "body": { + "description": "Contents of the issue", + "type": [ + "string", + "null" + ], + "examples": [ + "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?" + ] + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "labels": { + "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", + "type": "array", + "items": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "name": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "color": { + "type": [ + "string", + "null" + ] + }, + "default": { + "type": "boolean" + } + } + } + ] + }, + "examples": [ + "bug", + "registration" + ] + }, + "assignee": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "assignees": { + "type": [ + "array", + "null" + ], + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "milestone": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/milestones/v1.0" + ] + }, + "labels_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1002604 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDk6TWlsZXN0b25lMTAwMjYwNA==" + ] + }, + "number": { + "description": "The number of the milestone.", + "type": "integer", + "examples": [ + 42 + ] + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open", + "examples": [ + "open" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string", + "examples": [ + "v1.0" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "Tracking milestone for version 1.0" + ] + }, + "creator": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 4 + ] + }, + "closed_issues": { + "type": "integer", + "examples": [ + 8 + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-10T20:09:31Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2014-03-03T18:58:10Z" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2013-02-12T13:22:01Z" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2012-10-09T23:39:01Z" + ] + } + }, + "required": [ + "closed_issues", + "creator", + "description", + "due_on", + "closed_at", + "id", + "node_id", + "labels_url", + "html_url", + "number", + "open_issues", + "state", + "title", + "url", + "created_at", + "updated_at" + ] + } + ] + }, + "locked": { + "type": "boolean" + }, + "active_lock_reason": { + "type": [ + "string", + "null" + ] + }, + "comments": { + "type": "integer" + }, + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "diff_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "patch_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "closed_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "body_html": { + "type": "string" + }, + "body_text": { + "type": "string" + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "type": "string" + } + } + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] } }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] }, - "examples": [ - "label", - "deployment" - ] + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer", - "examples": [ - 5 - ] - } + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "dismissed_review": { - "type": "object", - "properties": { - "state": { - "type": "string" - }, - "review_id": { - "type": "integer" - }, - "dismissal_message": { - "type": [ - "string", - "null" - ] + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } }, - "dismissal_commit_id": { + "additionalProperties": { "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" } }, - "required": [ - "state", - "review_id", - "dismissal_message" - ] - } + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer", + "examples": [ + 5 + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + ] + }, + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ], + "examples": [ + "OWNER" + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" }, - "required": [ - "dismissed_review", - "id", - "node_id", - "url", - "actor", - "event", - "commit_id", - "commit_url", - "created_at", - "performed_via_github_app" - ] + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + } + }, + "required": [ + "assignee", + "closed_at", + "comments", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "labels", + "labels_url", + "milestone", + "number", + "repository_url", + "state", + "locked", + "title", + "url", + "user", + "author_association", + "created_at", + "updated_at" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "

You can use the REST API to remove a dependency that an issue is blocked by.

\n

Removing content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see Rate limits for the API\nand Best practices for using the REST API.

\n

This endpoint supports the following custom media types. For more information, see Media types.

\n", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "301", + "description": "

Moved permanently

" + }, + { + "httpStatusCode": "400", + "description": "

Bad Request

" + }, + { + "httpStatusCode": "401", + "description": "

Requires authentication

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "410", + "description": "

Gone

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocking", + "title": "List dependencies an issue is blocking", + "category": "issues", + "subcategory": "issue-dependencies", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "issue_number", + "description": "

The number that identifies the issue.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "per_page", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Issues\" repository permissions": "read" + } + ], + "allowsPublicRead": true + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "issue_number": "ISSUE_NUMBER" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": [ + { + "id": 1, + "node_id": "MDU6SXNzdWUx", + "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", + "repository_url": "https://api.github.com/repos/octocat/Hello-World", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", + "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events", + "html_url": "https://github.com/octocat/Hello-World/issues/1347", + "number": 1347, + "state": "open", + "title": "Found a bug", + "body": "I'm having a problem with this.", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "labels": [ { - "title": "Locked Issue Event", - "description": "Locked Issue Event", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" + "id": 208045946, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", + "name": "bug", + "description": "Something isn't working", + "color": "f29513", + "default": true + } + ], + "assignee": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "assignees": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + ], + "milestone": { + "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", + "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", + "id": 1002604, + "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", + "number": 1, + "state": "open", + "title": "v1.0", + "description": "Tracking milestone for version 1.0", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "open_issues": 4, + "closed_issues": 8, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z", + "closed_at": "2013-02-12T13:22:01Z", + "due_on": "2012-10-09T23:39:01Z" + }, + "locked": true, + "active_lock_reason": "too heated", + "comments": 0, + "pull_request": { + "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", + "html_url": "https://github.com/octocat/Hello-World/pull/1347", + "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", + "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch" + }, + "closed_at": null, + "created_at": "2011-04-22T13:33:48Z", + "updated_at": "2011-04-22T13:33:48Z", + "closed_by": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "author_association": "COLLABORATOR", + "state_reason": "completed" + } + ], + "schema": { + "type": "array", + "items": { + "title": "Issue", + "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repositories/42/issues/1" + ] + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "labels_url": { + "type": "string" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "number": { + "description": "Number uniquely identifying the issue within its repository", + "type": "integer", + "examples": [ + 42 + ] + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "examples": [ + "open" + ] + }, + "state_reason": { + "description": "The reason for the current state", + "type": [ + "string", + "null" + ], + "enum": [ + "completed", + "reopened", + "not_planned", + "duplicate", + null + ], + "examples": [ + "not_planned" + ] + }, + "title": { + "description": "Title of the issue", + "type": "string", + "examples": [ + "Widget creation fails in Safari on OS X 10.8" + ] + }, + "body": { + "description": "Contents of the issue", + "type": [ + "string", + "null" + ], + "examples": [ + "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?" + ] + }, + "user": { + "anyOf": [ + { + "type": "null" }, - "actor": { + { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -374504,471 +391061,64 @@ "type", "url" ] - }, - "event": { - "type": "string" - }, - "commit_id": { - "type": [ - "string", - "null" - ] - }, - "commit_url": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": "string" - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "GitHub app", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer", - "examples": [ - 37 - ] - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string", - "examples": [ - "probot-owners" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDExOkludGVncmF0aW9uMQ==" - ] - }, - "client_id": { - "type": "string", - "examples": [ - "\"Iv1.25b5d1e65ffc4022\"" - ] - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string", - "examples": [ - "Probot Owners" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "The description of the app." - ] - }, - "external_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://example.com" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/apps/super-ci" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "issues": { - "type": "string" - }, - "checks": { - "type": "string" - }, - "metadata": { - "type": "string" - }, - "contents": { - "type": "string" - }, - "deployments": { - "type": "string" - } - }, - "additionalProperties": { - "type": "string" - }, - "example": { - "issues": "read", - "deployments": "write" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "label", - "deployment" - ] - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer", - "examples": [ - 5 - ] - } + } + ] + }, + "labels": { + "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", + "type": "array", + "items": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "name": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "color": { + "type": [ + "string", + "null" + ] + }, + "default": { + "type": "boolean" + } } - ] - }, - "lock_reason": { - "type": [ - "string", - "null" - ], - "examples": [ - "\"off-topic\"" - ] - } + } + ] }, - "required": [ - "lock_reason", - "id", - "node_id", - "url", - "actor", - "event", - "commit_id", - "commit_url", - "created_at", - "performed_via_github_app" + "examples": [ + "bug", + "registration" ] }, - { - "title": "Added to Project Issue Event", - "description": "Added to Project Issue Event", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" + "assignee": { + "anyOf": [ + { + "type": "null" }, - "actor": { + { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -375135,1146 +391285,586 @@ "type", "url" ] - }, - "event": { - "type": "string" - }, - "commit_id": { - "type": [ - "string", - "null" - ] - }, - "commit_url": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": "string" - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "GitHub app", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer", - "examples": [ - 37 - ] - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string", - "examples": [ - "probot-owners" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDExOkludGVncmF0aW9uMQ==" - ] - }, - "client_id": { - "type": "string", - "examples": [ - "\"Iv1.25b5d1e65ffc4022\"" - ] - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string", - "examples": [ - "Probot Owners" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "The description of the app." - ] - }, - "external_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://example.com" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/apps/super-ci" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "issues": { - "type": "string" - }, - "checks": { - "type": "string" - }, - "metadata": { - "type": "string" - }, - "contents": { - "type": "string" - }, - "deployments": { - "type": "string" - } - }, - "additionalProperties": { - "type": "string" - }, - "example": { - "issues": "read", - "deployments": "write" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "label", - "deployment" - ] - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer", - "examples": [ - 5 - ] - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "project_card": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - }, - "project_id": { - "type": "integer" - }, - "project_url": { - "type": "string", - "format": "uri" - }, - "column_name": { - "type": "string" - }, - "previous_column_name": { - "type": "string" - } - }, - "required": [ - "id", - "url", - "project_id", - "project_url", - "column_name" - ] } - }, - "required": [ - "id", - "node_id", - "url", - "actor", - "event", - "commit_id", - "commit_url", - "created_at", - "performed_via_github_app" ] }, - { - "title": "Moved Column in Project Issue Event", - "description": "Moved Column in Project Issue Event", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" + "assignees": { + "type": [ + "array", + "null" + ], + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } }, - "actor": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "milestone": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/subscriptions" + "https://api.github.com/repos/octocat/Hello-World/milestones/1" ] }, - "organizations_url": { + "html_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/orgs" + "https://github.com/octocat/Hello-World/milestones/v1.0" ] }, - "repos_url": { + "labels_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/repos" + "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" ] }, - "events_url": { - "type": "string", + "id": { + "type": "integer", "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + 1002604 ] }, - "received_events_url": { + "node_id": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/received_events" + "MDk6TWlsZXN0b25lMTAwMjYwNA==" ] }, - "type": { - "type": "string", + "number": { + "description": "The number of the milestone.", + "type": "integer", "examples": [ - "User" + 42 ] }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { + "state": { + "description": "The state of the milestone.", "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open", "examples": [ - "\"2020-07-09T00:17:55Z\"" + "open" ] }, - "user_view_type": { + "title": { + "description": "The title of the milestone.", "type": "string", "examples": [ - "public" + "v1.0" ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "event": { - "type": "string" - }, - "commit_id": { - "type": [ - "string", - "null" - ] - }, - "commit_url": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": "string" - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" }, - { - "title": "GitHub app", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "description": { "type": [ - "object", + "string", "null" ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer", - "examples": [ - 37 - ] - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string", - "examples": [ - "probot-owners" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDExOkludGVncmF0aW9uMQ==" - ] - }, - "client_id": { - "type": "string", - "examples": [ - "\"Iv1.25b5d1e65ffc4022\"" - ] + "examples": [ + "Tracking milestone for version 1.0" + ] + }, + "creator": { + "anyOf": [ + { + "type": "null" }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" ] }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" + "email": { + "type": [ + "string", + "null" ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string", - "examples": [ - "Probot Owners" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "The description of the app." - ] - }, - "external_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://example.com" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/apps/super-ci" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "issues": { - "type": "string" }, - "checks": { - "type": "string" + "login": { + "type": "string", + "examples": [ + "octocat" + ] }, - "metadata": { - "type": "string" + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] }, - "contents": { - "type": "string" + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] }, - "deployments": { - "type": "string" + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] } }, - "additionalProperties": { - "type": "string" - }, - "example": { - "issues": "read", - "deployments": "write" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "label", - "deployment" - ] - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer", - "examples": [ - 5 + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" ] - } - ] - }, - "project_card": { - "type": "object", - "properties": { - "id": { - "type": "integer" }, - "url": { - "type": "string", - "format": "uri" + "open_issues": { + "type": "integer", + "examples": [ + 4 + ] }, - "project_id": { - "type": "integer" + "closed_issues": { + "type": "integer", + "examples": [ + 8 + ] }, - "project_url": { + "created_at": { "type": "string", - "format": "uri" + "format": "date-time", + "examples": [ + "2011-04-10T20:09:31Z" + ] }, - "column_name": { - "type": "string" + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2014-03-03T18:58:10Z" + ] }, - "previous_column_name": { - "type": "string" + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2013-02-12T13:22:01Z" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2012-10-09T23:39:01Z" + ] } }, "required": [ + "closed_issues", + "creator", + "description", + "due_on", + "closed_at", "id", + "node_id", + "labels_url", + "html_url", + "number", + "open_issues", + "state", + "title", "url", - "project_id", - "project_url", - "column_name" + "created_at", + "updated_at" ] } - }, - "required": [ - "id", - "node_id", - "url", - "actor", - "event", - "commit_id", - "commit_url", - "created_at", - "performed_via_github_app" ] }, - { - "title": "Removed from Project Issue Event", - "description": "Removed from Project Issue Event", + "locked": { + "type": "boolean" + }, + "active_lock_reason": { + "type": [ + "string", + "null" + ] + }, + "comments": { + "type": "integer" + }, + "pull_request": { "type": "object", "properties": { - "id": { - "type": "integer" + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" }, - "node_id": { - "type": "string" + "diff_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "patch_url": { + "type": [ + "string", + "null" + ], + "format": "uri" }, "url": { - "type": "string" + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "closed_by": { + "anyOf": [ + { + "type": "null" }, - "actor": { + { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -376441,493 +392031,209 @@ "type", "url" ] + } + ] + }, + "body_html": { + "type": "string" + }, + "body_text": { + "type": "string" + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." }, - "event": { - "type": "string" + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." }, - "commit_id": { + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { "type": [ "string", "null" - ] + ], + "description": "The description of the issue type." }, - "commit_url": { + "color": { "type": [ "string", "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null ] }, "created_at": { - "type": "string" + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" }, - "performed_via_github_app": { + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { "anyOf": [ { "type": "null" }, { - "title": "GitHub app", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": [ - "object", - "null" - ], + "title": "License Simple", + "description": "License Simple", + "type": "object", "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer", - "examples": [ - 37 - ] - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string", - "examples": [ - "probot-owners" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDExOkludGVncmF0aW9uMQ==" - ] - }, - "client_id": { + "key": { "type": "string", "examples": [ - "\"Iv1.25b5d1e65ffc4022\"" - ] - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } + "mit" ] }, "name": { - "description": "The name of the GitHub app", "type": "string", "examples": [ - "Probot Owners" + "MIT License" ] }, - "description": { + "url": { "type": [ "string", "null" ], - "examples": [ - "The description of the app." - ] - }, - "external_url": { - "type": "string", "format": "uri", "examples": [ - "https://example.com" + "https://api.github.com/licenses/mit" ] }, - "html_url": { - "type": "string", - "format": "uri", + "spdx_id": { + "type": [ + "string", + "null" + ], "examples": [ - "https://github.com/apps/super-ci" + "MIT" ] }, - "created_at": { + "node_id": { "type": "string", - "format": "date-time", "examples": [ - "2017-07-08T16:18:44-04:00" + "MDc6TGljZW5zZW1pdA==" ] }, - "updated_at": { + "html_url": { "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "issues": { - "type": "string" - }, - "checks": { - "type": "string" - }, - "metadata": { - "type": "string" - }, - "contents": { - "type": "string" - }, - "deployments": { - "type": "string" - } - }, - "additionalProperties": { - "type": "string" - }, - "example": { - "issues": "read", - "deployments": "write" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "label", - "deployment" - ] - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer", - "examples": [ - 5 - ] + "format": "uri" } }, "required": [ - "id", - "node_id", - "owner", + "key", "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" + "url", + "spdx_id", + "node_id" ] } ] }, - "project_card": { + "forks": { + "type": "integer" + }, + "permissions": { "type": "object", "properties": { - "id": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" + "admin": { + "type": "boolean" }, - "project_id": { - "type": "integer" + "pull": { + "type": "boolean" }, - "project_url": { - "type": "string", - "format": "uri" + "triage": { + "type": "boolean" }, - "column_name": { - "type": "string" + "push": { + "type": "boolean" }, - "previous_column_name": { - "type": "string" + "maintain": { + "type": "boolean" } }, "required": [ - "id", - "url", - "project_id", - "project_url", - "column_name" + "admin", + "pull", + "push" ] - } - }, - "required": [ - "id", - "node_id", - "url", - "actor", - "event", - "commit_id", - "commit_url", - "created_at", - "performed_via_github_app" - ] - }, - { - "title": "Converted Note to Issue Issue Event", - "description": "Converted Note to Issue Issue Event", - "type": "object", - "properties": { - "id": { - "type": "integer" }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "actor": { + "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -377095,25 +392401,671 @@ "url" ] }, - "event": { - "type": "string" + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" }, - "commit_id": { + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { "type": [ "string", "null" + ], + "examples": [ + "This your first repo!" ] }, - "commit_url": { + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { "type": [ "string", "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" ] }, "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "temp_clone_token": { "type": "string" }, - "performed_via_github_app": { + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "type": "string" + } + } + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": [ @@ -377513,52 +393465,143 @@ "permissions", "events" ] + } + ] + }, + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ], + "examples": [ + "OWNER" + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" }, - "project_card": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - }, - "project_id": { - "type": "integer" - }, - "project_url": { - "type": "string", - "format": "uri" - }, - "column_name": { - "type": "string" - }, - "previous_column_name": { - "type": "string" - } - }, - "required": [ - "id", - "url", - "project_id", - "project_url", - "column_name" - ] + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" } }, "required": [ - "id", - "node_id", "url", - "actor", - "event", - "commit_id", - "commit_url", - "created_at", - "performed_via_github_app" + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" ] } + }, + "required": [ + "assignee", + "closed_at", + "comments", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "labels", + "labels_url", + "milestone", + "number", + "repository_url", + "state", + "locked", + "title", + "url", + "user", + "author_association", + "created_at", + "updated_at" ] } } @@ -377566,12 +393609,20 @@ } ], "previews": [], - "descriptionHTML": "

Lists all events for an issue.

", + "descriptionHTML": "

You can use the REST API to list the dependencies an issue is blocking.

\n

This endpoint supports the following custom media types. For more information, see Media types.

\n", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" }, + { + "httpStatusCode": "301", + "description": "

Moved permanently

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, { "httpStatusCode": "410", "description": "

Gone

" @@ -384349,6 +400400,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -387391,6 +403466,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -390429,6 +406528,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -393481,6 +409604,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -407020,6 +423167,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -432587,13 +448758,13 @@ } ], "previews": [], - "descriptionHTML": "

Get overall statistics of API requests made within an organization by all users and apps within a specified time frame.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Get overall statistics of API requests made within an organization by all users and apps within a specified time frame.

" }, { "serverUrl": "https://api.github.com", @@ -444949,13 +461120,13 @@ } ], "previews": [], - "descriptionHTML": "

Gets a hosted compute network configuration configured in an organization.

\n

OAuth app tokens and personal access tokens (classic) need the read:network_configurations scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Gets a hosted compute network configuration configured in an organization.

\n

OAuth app tokens and personal access tokens (classic) need the read:network_configurations scope to use this endpoint.

" }, { "serverUrl": "https://api.github.com", @@ -445295,13 +461466,13 @@ } ], "previews": [], - "descriptionHTML": "

Gets a hosted compute network settings resource configured for an organization.

\n

OAuth app tokens and personal access tokens (classic) need the read:network_configurations scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Gets a hosted compute network settings resource configured for an organization.

\n

OAuth app tokens and personal access tokens (classic) need the read:network_configurations scope to use this endpoint.

" } ], "organization-roles": [ @@ -446459,13 +462630,13 @@ } ], "previews": [], - "descriptionHTML": "

Revokes all assigned organization roles from a user. For more information on organization roles, see \"Using organization roles.\"

\n

The authenticated user must be an administrator for the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ] + ], + "descriptionHTML": "

Revokes all assigned organization roles from a user. For more information on organization roles, see \"Using organization roles.\"

\n

The authenticated user must be an administrator for the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" }, { "serverUrl": "https://api.github.com", @@ -479246,13 +495417,13 @@ } ], "previews": [], - "descriptionHTML": "

Gets information about a GitHub Enterprise Cloud Pages build.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Gets information about a GitHub Enterprise Cloud Pages build.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" }, { "serverUrl": "https://api.github.com", @@ -479611,7 +495782,6 @@ } ], "previews": [], - "descriptionHTML": "

Cancels a GitHub Pages deployment.

\n

The authenticated user must have write permissions for the GitHub Pages site.

", "statusCodes": [ { "httpStatusCode": "204", @@ -479621,7 +495791,8 @@ "httpStatusCode": "404", "description": "

Resource not found

" } - ] + ], + "descriptionHTML": "

Cancels a GitHub Pages deployment.

\n

The authenticated user must have write permissions for the GitHub Pages site.

" }, { "serverUrl": "https://api.github.com", @@ -567515,13 +583686,13 @@ } ], "previews": [], - "descriptionHTML": "

Creates a new repository using a repository template. Use the template_owner and template_repo route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the Get a repository endpoint and check that the is_template key is true.

\n

OAuth app tokens and personal access tokens (classic) need the public_repo or repo scope to create a public repository, and repo scope to create a private repository.

", "statusCodes": [ { "httpStatusCode": "201", "description": "

Created

" } - ] + ], + "descriptionHTML": "

Creates a new repository using a repository template. Use the template_owner and template_repo route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the Get a repository endpoint and check that the is_template key is true.

\n

OAuth app tokens and personal access tokens (classic) need the public_repo or repo scope to create a public repository, and repo scope to create a private repository.

" }, { "serverUrl": "https://api.github.com", @@ -575995,7 +592166,6 @@ } ], "previews": [], - "descriptionHTML": "

Users with admin access to the repository can create an autolink.

", "statusCodes": [ { "httpStatusCode": "201", @@ -576005,7 +592175,8 @@ "httpStatusCode": "422", "description": "

Validation failed, or the endpoint has been spammed.

" } - ] + ], + "descriptionHTML": "

Users with admin access to the repository can create an autolink.

" }, { "serverUrl": "https://api.github.com", @@ -605797,6 +621968,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "type": "string" }, @@ -621337,6 +637532,854 @@ } ] } + ], + "push-protection": [ + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/enterprises/{enterprise}/secret-scanning/pattern-configurations", + "title": "List enterprise pattern configurations", + "category": "secret-scanning", + "subcategory": "push-protection", + "parameters": [ + { + "name": "enterprise", + "description": "

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "enterprise": "ENTERPRISE" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "pattern_config_version": "0ujsswThIGTUYm2K8FjOOfXtY1K", + "provider_pattern_overrides": [ + { + "token_type": "GITHUB_PERSONAL_ACCESS_TOKEN", + "slug": "github_personal_access_token_legacy_v2", + "display_name": "GitHub Personal Access Token (Legacy v2)", + "alert_total": 15, + "alert_total_percentage": 36, + "false_positives": 2, + "false_positive_rate": 13, + "bypass_rate": 13, + "default_setting": "enabled", + "setting": "enabled", + "enterprise_setting": "enabled" + } + ], + "custom_pattern_overrides": [ + { + "token_type": "cp_2", + "custom_pattern_version": "0ujsswThIGTUYm2K8FjOOfXtY1K", + "slug": "custom-api-key", + "display_name": "Custom API Key", + "alert_total": 15, + "alert_total_percentage": 36, + "false_positives": 3, + "false_positive_rate": 20, + "bypass_rate": 20, + "default_setting": "disabled", + "setting": "enabled" + } + ] + }, + "schema": { + "title": "Secret scanning pattern configuration", + "description": "A collection of secret scanning patterns and their settings related to push protection.", + "type": "object", + "properties": { + "pattern_config_version": { + "type": [ + "string", + "null" + ], + "description": "The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate unintentionally overriding someone else's update." + }, + "provider_pattern_overrides": { + "type": "array", + "description": "Overrides for partner patterns.", + "items": { + "type": "object", + "properties": { + "token_type": { + "type": "string", + "description": "The ID of the pattern." + }, + "custom_pattern_version": { + "type": [ + "string", + "null" + ], + "description": "The version of this pattern if it's a custom pattern." + }, + "slug": { + "type": "string", + "description": "The slug of the pattern." + }, + "display_name": { + "type": "string", + "description": "The user-friendly name for the pattern." + }, + "alert_total": { + "type": "integer", + "description": "The total number of alerts generated by this pattern." + }, + "alert_total_percentage": { + "type": "integer", + "description": "The percentage of all alerts that this pattern represents, rounded to the nearest integer." + }, + "false_positives": { + "type": "integer", + "description": "The number of false positive alerts generated by this pattern." + }, + "false_positive_rate": { + "type": "integer", + "description": "The percentage of alerts from this pattern that are false positives, rounded to the nearest integer." + }, + "bypass_rate": { + "type": "integer", + "description": "The percentage of blocks for this pattern that were bypassed, rounded to the nearest integer." + }, + "default_setting": { + "type": "string", + "description": "The default push protection setting for this pattern.", + "enum": [ + "disabled", + "enabled" + ] + }, + "enterprise_setting": { + "type": [ + "string", + "null" + ], + "description": "The push protection setting for this pattern set at the enterprise level. Only present for partner patterns when the organization has a parent enterprise.", + "enum": [ + "not-set", + "disabled", + "enabled", + null + ] + }, + "setting": { + "type": "string", + "description": "The current push protection setting for this pattern. If this is `not-set`, then it inherits either the enterprise setting if it exists or the default setting.", + "enum": [ + "not-set", + "disabled", + "enabled" + ] + } + } + } + }, + "custom_pattern_overrides": { + "type": "array", + "description": "Overrides for custom patterns defined by the organization.", + "items": { + "type": "object", + "properties": { + "token_type": { + "type": "string", + "description": "The ID of the pattern." + }, + "custom_pattern_version": { + "type": [ + "string", + "null" + ], + "description": "The version of this pattern if it's a custom pattern." + }, + "slug": { + "type": "string", + "description": "The slug of the pattern." + }, + "display_name": { + "type": "string", + "description": "The user-friendly name for the pattern." + }, + "alert_total": { + "type": "integer", + "description": "The total number of alerts generated by this pattern." + }, + "alert_total_percentage": { + "type": "integer", + "description": "The percentage of all alerts that this pattern represents, rounded to the nearest integer." + }, + "false_positives": { + "type": "integer", + "description": "The number of false positive alerts generated by this pattern." + }, + "false_positive_rate": { + "type": "integer", + "description": "The percentage of alerts from this pattern that are false positives, rounded to the nearest integer." + }, + "bypass_rate": { + "type": "integer", + "description": "The percentage of blocks for this pattern that were bypassed, rounded to the nearest integer." + }, + "default_setting": { + "type": "string", + "description": "The default push protection setting for this pattern.", + "enum": [ + "disabled", + "enabled" + ] + }, + "enterprise_setting": { + "type": [ + "string", + "null" + ], + "description": "The push protection setting for this pattern set at the enterprise level. Only present for partner patterns when the organization has a parent enterprise.", + "enum": [ + "not-set", + "disabled", + "enabled", + null + ] + }, + "setting": { + "type": "string", + "description": "The current push protection setting for this pattern. If this is `not-set`, then it inherits either the enterprise setting if it exists or the default setting.", + "enum": [ + "not-set", + "disabled", + "enabled" + ] + } + } + } + } + } + } + } + } + ], + "previews": [], + "descriptionHTML": "

Lists the secret scanning pattern configurations for an enterprise.

\n

Personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "patch", + "requestPath": "/enterprises/{enterprise}/secret-scanning/pattern-configurations", + "title": "Update enterprise pattern configurations", + "category": "secret-scanning", + "subcategory": "push-protection", + "parameters": [ + { + "name": "enterprise", + "description": "

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "string or null", + "name": "pattern_config_version", + "in": "body", + "description": "

The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate unintentionally overriding someone else's update.

" + }, + { + "type": "array of objects", + "name": "provider_pattern_settings", + "in": "body", + "description": "

Pattern settings for provider patterns.

", + "childParamsGroups": [ + { + "type": "string", + "name": "token_type", + "description": "

The ID of the pattern to configure.

" + }, + { + "type": "string", + "name": "push_protection_setting", + "description": "

Push protection setting to set for the pattern.

", + "enum": [ + "not-set", + "disabled", + "enabled" + ] + } + ] + }, + { + "type": "array of objects", + "name": "custom_pattern_settings", + "in": "body", + "description": "

Pattern settings for custom patterns.

", + "childParamsGroups": [ + { + "type": "string", + "name": "token_type", + "description": "

The ID of the pattern to configure.

" + }, + { + "type": "string or null", + "name": "custom_pattern_version", + "description": "

The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate unintentionally overriding someone else's update.

" + }, + { + "type": "string", + "name": "push_protection_setting", + "description": "

Push protection setting to set for the pattern.

", + "enum": [ + "disabled", + "enabled" + ] + } + ] + } + ], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "pattern_config_version": "0ujsswThIGTUYm2K8FjOOfXtY1K", + "provider_pattern_settings": [ + { + "token_type": "GITHUB_PERSONAL_ACCESS_TOKEN", + "push_protection_setting": "enabled" + } + ], + "custom_pattern_settings": [ + { + "token_type": "cp_2", + "custom_pattern_version": "0ujsswThIGTUYm2K8FjOOfXtY1K", + "push_protection_setting": "enabled" + } + ] + }, + "parameters": { + "enterprise": "ENTERPRISE" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "pattern_config_version": "0ujsswThIGTUYm2K8FjOOfXtY1K" + }, + "schema": { + "type": "object", + "properties": { + "pattern_config_version": { + "type": "string", + "description": "The updated pattern configuration version." + } + } + } + } + } + ], + "previews": [], + "descriptionHTML": "

Updates the secret scanning pattern configurations for an enterprise.

\n

Personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "400", + "description": "

Bad Request

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "409", + "description": "

Conflict

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/secret-scanning/pattern-configurations", + "title": "List organization pattern configurations", + "category": "secret-scanning", + "subcategory": "push-protection", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Administration\" organization permissions": "write" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "pattern_config_version": "0ujsswThIGTUYm2K8FjOOfXtY1K", + "provider_pattern_overrides": [ + { + "token_type": "GITHUB_PERSONAL_ACCESS_TOKEN", + "slug": "github_personal_access_token_legacy_v2", + "display_name": "GitHub Personal Access Token (Legacy v2)", + "alert_total": 15, + "alert_total_percentage": 36, + "false_positives": 2, + "false_positive_rate": 13, + "bypass_rate": 13, + "default_setting": "enabled", + "setting": "enabled", + "enterprise_setting": "enabled" + } + ], + "custom_pattern_overrides": [ + { + "token_type": "cp_2", + "custom_pattern_version": "0ujsswThIGTUYm2K8FjOOfXtY1K", + "slug": "custom-api-key", + "display_name": "Custom API Key", + "alert_total": 15, + "alert_total_percentage": 36, + "false_positives": 3, + "false_positive_rate": 20, + "bypass_rate": 20, + "default_setting": "disabled", + "setting": "enabled" + } + ] + }, + "schema": { + "title": "Secret scanning pattern configuration", + "description": "A collection of secret scanning patterns and their settings related to push protection.", + "type": "object", + "properties": { + "pattern_config_version": { + "type": [ + "string", + "null" + ], + "description": "The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate unintentionally overriding someone else's update." + }, + "provider_pattern_overrides": { + "type": "array", + "description": "Overrides for partner patterns.", + "items": { + "type": "object", + "properties": { + "token_type": { + "type": "string", + "description": "The ID of the pattern." + }, + "custom_pattern_version": { + "type": [ + "string", + "null" + ], + "description": "The version of this pattern if it's a custom pattern." + }, + "slug": { + "type": "string", + "description": "The slug of the pattern." + }, + "display_name": { + "type": "string", + "description": "The user-friendly name for the pattern." + }, + "alert_total": { + "type": "integer", + "description": "The total number of alerts generated by this pattern." + }, + "alert_total_percentage": { + "type": "integer", + "description": "The percentage of all alerts that this pattern represents, rounded to the nearest integer." + }, + "false_positives": { + "type": "integer", + "description": "The number of false positive alerts generated by this pattern." + }, + "false_positive_rate": { + "type": "integer", + "description": "The percentage of alerts from this pattern that are false positives, rounded to the nearest integer." + }, + "bypass_rate": { + "type": "integer", + "description": "The percentage of blocks for this pattern that were bypassed, rounded to the nearest integer." + }, + "default_setting": { + "type": "string", + "description": "The default push protection setting for this pattern.", + "enum": [ + "disabled", + "enabled" + ] + }, + "enterprise_setting": { + "type": [ + "string", + "null" + ], + "description": "The push protection setting for this pattern set at the enterprise level. Only present for partner patterns when the organization has a parent enterprise.", + "enum": [ + "not-set", + "disabled", + "enabled", + null + ] + }, + "setting": { + "type": "string", + "description": "The current push protection setting for this pattern. If this is `not-set`, then it inherits either the enterprise setting if it exists or the default setting.", + "enum": [ + "not-set", + "disabled", + "enabled" + ] + } + } + } + }, + "custom_pattern_overrides": { + "type": "array", + "description": "Overrides for custom patterns defined by the organization.", + "items": { + "type": "object", + "properties": { + "token_type": { + "type": "string", + "description": "The ID of the pattern." + }, + "custom_pattern_version": { + "type": [ + "string", + "null" + ], + "description": "The version of this pattern if it's a custom pattern." + }, + "slug": { + "type": "string", + "description": "The slug of the pattern." + }, + "display_name": { + "type": "string", + "description": "The user-friendly name for the pattern." + }, + "alert_total": { + "type": "integer", + "description": "The total number of alerts generated by this pattern." + }, + "alert_total_percentage": { + "type": "integer", + "description": "The percentage of all alerts that this pattern represents, rounded to the nearest integer." + }, + "false_positives": { + "type": "integer", + "description": "The number of false positive alerts generated by this pattern." + }, + "false_positive_rate": { + "type": "integer", + "description": "The percentage of alerts from this pattern that are false positives, rounded to the nearest integer." + }, + "bypass_rate": { + "type": "integer", + "description": "The percentage of blocks for this pattern that were bypassed, rounded to the nearest integer." + }, + "default_setting": { + "type": "string", + "description": "The default push protection setting for this pattern.", + "enum": [ + "disabled", + "enabled" + ] + }, + "enterprise_setting": { + "type": [ + "string", + "null" + ], + "description": "The push protection setting for this pattern set at the enterprise level. Only present for partner patterns when the organization has a parent enterprise.", + "enum": [ + "not-set", + "disabled", + "enabled", + null + ] + }, + "setting": { + "type": "string", + "description": "The current push protection setting for this pattern. If this is `not-set`, then it inherits either the enterprise setting if it exists or the default setting.", + "enum": [ + "not-set", + "disabled", + "enabled" + ] + } + } + } + } + } + } + } + } + ], + "previews": [], + "descriptionHTML": "

Lists the secret scanning pattern configurations for an organization.

\n

Personal access tokens (classic) need the write:org scope to use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "patch", + "requestPath": "/orgs/{org}/secret-scanning/pattern-configurations", + "title": "Update organization pattern configurations", + "category": "secret-scanning", + "subcategory": "push-protection", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "string or null", + "name": "pattern_config_version", + "in": "body", + "description": "

The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate unintentionally overriding someone else's update.

" + }, + { + "type": "array of objects", + "name": "provider_pattern_settings", + "in": "body", + "description": "

Pattern settings for provider patterns.

", + "childParamsGroups": [ + { + "type": "string", + "name": "token_type", + "description": "

The ID of the pattern to configure.

" + }, + { + "type": "string", + "name": "push_protection_setting", + "description": "

Push protection setting to set for the pattern.

", + "enum": [ + "not-set", + "disabled", + "enabled" + ] + } + ] + }, + { + "type": "array of objects", + "name": "custom_pattern_settings", + "in": "body", + "description": "

Pattern settings for custom patterns.

", + "childParamsGroups": [ + { + "type": "string", + "name": "token_type", + "description": "

The ID of the pattern to configure.

" + }, + { + "type": "string or null", + "name": "custom_pattern_version", + "description": "

The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate unintentionally overriding someone else's update.

" + }, + { + "type": "string", + "name": "push_protection_setting", + "description": "

Push protection setting to set for the pattern.

", + "enum": [ + "disabled", + "enabled" + ] + } + ] + } + ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Administration\" organization permissions": "write" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "pattern_config_version": "0ujsswThIGTUYm2K8FjOOfXtY1K", + "provider_pattern_settings": [ + { + "token_type": "GITHUB_PERSONAL_ACCESS_TOKEN", + "push_protection_setting": "enabled" + } + ], + "custom_pattern_settings": [ + { + "token_type": "cp_2", + "custom_pattern_version": "0ujsswThIGTUYm2K8FjOOfXtY1K", + "push_protection_setting": "enabled" + } + ] + }, + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "pattern_config_version": "0ujsswThIGTUYm2K8FjOOfXtY1K" + }, + "schema": { + "type": "object", + "properties": { + "pattern_config_version": { + "type": "string", + "description": "The updated pattern configuration version." + } + } + } + } + } + ], + "previews": [], + "descriptionHTML": "

Updates the secret scanning pattern configurations for an organization.

\n

Personal access tokens (classic) need the write:org scope to use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "400", + "description": "

Bad Request

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "409", + "description": "

Conflict

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + } + ] + } ] }, "security-advisories": { @@ -648521,13 +665564,13 @@ } ], "previews": [], - "descriptionHTML": "

Warning

\n

\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.

\n
", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Warning

\n

\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.

\n
" }, { "serverUrl": "https://api.github.com", @@ -660361,13 +677404,13 @@ } ], "previews": [], - "descriptionHTML": "

Deletes a comment on a team discussion.

\n

Note

\n

\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.

\n
\n

OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ] + ], + "descriptionHTML": "

Deletes a comment on a team discussion.

\n

Note

\n

\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.

\n
\n

OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.

" }, { "serverUrl": "https://api.github.com", @@ -662758,13 +679801,13 @@ } ], "previews": [], - "descriptionHTML": "

List all discussions on a team's page.

\n

Note

\n

\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions.

\n
\n

OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

List all discussions on a team's page.

\n

Note

\n

\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions.

\n
\n

OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.

" }, { "serverUrl": "https://api.github.com", @@ -677469,504 +694512,504 @@ } ], "previews": [], - "descriptionHTML": "

Lists the people who the authenticated user follows.

", - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/user/following/{username}", - "title": "Check if a person is followed by the authenticated user", - "category": "users", - "subcategory": "followers", - "parameters": [ - { - "name": "username", - "description": "

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": false, - "fineGrainedPat": true, - "permissions": [ - { - "\"Followers\" user permissions": "read" - } - ] - }, - "codeExamples": [ - { - "key": "204", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "username": "USERNAME" - } - }, - "response": { - "statusCode": "204", - "description": "

if the person is followed by the authenticated user

" - } - } - ], - "previews": [], - "descriptionHTML": "", - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

if the person is followed by the authenticated user

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

if the person is not followed by the authenticated user

" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "put", - "requestPath": "/user/following/{username}", - "title": "Follow a user", - "category": "users", - "subcategory": "followers", - "parameters": [ - { - "name": "username", - "description": "

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": false, - "fineGrainedPat": true, - "permissions": [ - { - "\"Followers\" user permissions": "write" - } - ] - }, - "codeExamples": [ - { - "key": "204", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "username": "USERNAME" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "previews": [], - "descriptionHTML": "

Note that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"

\n

OAuth app tokens and personal access tokens (classic) need the user:follow scope to use this endpoint.

", - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "delete", - "requestPath": "/user/following/{username}", - "title": "Unfollow a user", - "category": "users", - "subcategory": "followers", - "parameters": [ - { - "name": "username", - "description": "

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": false, - "fineGrainedPat": true, - "permissions": [ - { - "\"Followers\" user permissions": "write" - } - ] - }, - "codeExamples": [ - { - "key": "204", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "username": "USERNAME" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "previews": [], - "descriptionHTML": "

OAuth app tokens and personal access tokens (classic) need the user:follow scope to use this endpoint.

", - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/users/{username}/followers", - "title": "List followers of a user", - "category": "users", - "subcategory": "followers", - "parameters": [ - { - "name": "username", - "description": "

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [], - "allowPermissionlessAccess": true, - "allowsPublicRead": true - }, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "username": "USERNAME" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } - ], - "schema": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - } - } - } - ], - "previews": [], - "descriptionHTML": "

Lists the people following the specified user.

", + "descriptionHTML": "

Lists the people who the authenticated user follows.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" + }, + { + "httpStatusCode": "304", + "description": "

Not modified

" + }, + { + "httpStatusCode": "401", + "description": "

Requires authentication

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/user/following/{username}", + "title": "Check if a person is followed by the authenticated user", + "category": "users", + "subcategory": "followers", + "parameters": [ + { + "name": "username", + "description": "

The handle for the GitHub user account.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": false, + "fineGrainedPat": true, + "permissions": [ + { + "\"Followers\" user permissions": "read" + } + ] + }, + "codeExamples": [ + { + "key": "204", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "username": "USERNAME" + } + }, + "response": { + "statusCode": "204", + "description": "

if the person is followed by the authenticated user

" + } + } + ], + "previews": [], + "descriptionHTML": "", + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "

if the person is followed by the authenticated user

" + }, + { + "httpStatusCode": "304", + "description": "

Not modified

" + }, + { + "httpStatusCode": "401", + "description": "

Requires authentication

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

if the person is not followed by the authenticated user

" } ] }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/user/following/{username}", + "title": "Follow a user", + "category": "users", + "subcategory": "followers", + "parameters": [ + { + "name": "username", + "description": "

The handle for the GitHub user account.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": false, + "fineGrainedPat": true, + "permissions": [ + { + "\"Followers\" user permissions": "write" + } + ] + }, + "codeExamples": [ + { + "key": "204", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "username": "USERNAME" + } + }, + "response": { + "statusCode": "204", + "description": "

Response

" + } + } + ], + "previews": [], + "descriptionHTML": "

Note that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"

\n

OAuth app tokens and personal access tokens (classic) need the user:follow scope to use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "

No Content

" + }, + { + "httpStatusCode": "304", + "description": "

Not modified

" + }, + { + "httpStatusCode": "401", + "description": "

Requires authentication

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "delete", + "requestPath": "/user/following/{username}", + "title": "Unfollow a user", + "category": "users", + "subcategory": "followers", + "parameters": [ + { + "name": "username", + "description": "

The handle for the GitHub user account.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": false, + "fineGrainedPat": true, + "permissions": [ + { + "\"Followers\" user permissions": "write" + } + ] + }, + "codeExamples": [ + { + "key": "204", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "username": "USERNAME" + } + }, + "response": { + "statusCode": "204", + "description": "

Response

" + } + } + ], + "previews": [], + "descriptionHTML": "

OAuth app tokens and personal access tokens (classic) need the user:follow scope to use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "

No Content

" + }, + { + "httpStatusCode": "304", + "description": "

Not modified

" + }, + { + "httpStatusCode": "401", + "description": "

Requires authentication

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/users/{username}/followers", + "title": "List followers of a user", + "category": "users", + "subcategory": "followers", + "parameters": [ + { + "name": "username", + "description": "

The handle for the GitHub user account.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [], + "allowPermissionlessAccess": true, + "allowsPublicRead": true + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "username": "USERNAME" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + ], + "schema": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + } + } + } + ], + "previews": [], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + } + ], + "descriptionHTML": "

Lists the people following the specified user.

" + }, { "serverUrl": "https://api.github.com", "verb": "get", @@ -680238,13 +697281,13 @@ } ], "previews": [], - "descriptionHTML": "

Lists the verified public SSH keys for a user. This is accessible by anyone.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Lists the verified public SSH keys for a user. This is accessible by anyone.

" } ], "social-accounts": [ @@ -680634,13 +697677,13 @@ } ], "previews": [], - "descriptionHTML": "

Lists social media accounts for a user. This endpoint is accessible by anyone.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Lists social media accounts for a user. This endpoint is accessible by anyone.

" } ], "ssh-signing-keys": [ diff --git a/src/rest/data/ghes-3.14-2022-11-28/schema.json b/src/rest/data/ghes-3.14-2022-11-28/schema.json index b22ad1becfc8..9a17c04fff7d 100644 --- a/src/rest/data/ghes-3.14-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.14-2022-11-28/schema.json @@ -46864,6 +46864,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -50676,6 +50700,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -54482,6 +54530,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -58286,6 +58358,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -62076,6 +62172,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -65890,6 +66010,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -69680,6 +69824,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -73481,6 +73649,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -77282,6 +77474,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -240907,6 +241123,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -244116,6 +244356,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -247247,6 +247511,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -250311,6 +250599,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -253341,6 +253653,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -256444,6 +256780,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -259838,6 +260198,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -263237,6 +263621,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -266259,6 +266667,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -273973,6 +274405,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -278738,6 +279194,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -308796,6 +309276,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -493765,6 +494269,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "type": "string" }, diff --git a/src/rest/data/ghes-3.15-2022-11-28/schema.json b/src/rest/data/ghes-3.15-2022-11-28/schema.json index 8998fc0db93e..b1dff5d4ee0f 100644 --- a/src/rest/data/ghes-3.15-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.15-2022-11-28/schema.json @@ -47008,6 +47008,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -50832,6 +50856,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -54650,6 +54698,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -58466,6 +58538,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -62268,6 +62364,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -66094,6 +66214,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -69896,6 +70040,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -73709,6 +73877,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -77522,6 +77714,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -243834,6 +244050,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -247049,6 +247289,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -250186,6 +250450,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -253256,6 +253544,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -256292,6 +256604,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -259401,6 +259737,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -262801,6 +263161,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -266206,6 +266590,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -269234,6 +269642,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -276984,6 +277416,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -281761,6 +282217,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -312005,6 +312485,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -498309,6 +498813,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "type": "string" }, diff --git a/src/rest/data/ghes-3.16-2022-11-28/schema.json b/src/rest/data/ghes-3.16-2022-11-28/schema.json index eea1cb90a5fe..8e87268fd960 100644 --- a/src/rest/data/ghes-3.16-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.16-2022-11-28/schema.json @@ -47008,6 +47008,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -50832,6 +50856,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -54650,6 +54698,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -58466,6 +58538,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -62268,6 +62364,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -66094,6 +66214,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -69896,6 +70040,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -73709,6 +73877,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -77522,6 +77714,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -249065,6 +249281,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -252280,6 +252520,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -255417,6 +255681,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -258487,6 +258775,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -261523,6 +261835,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -264632,6 +264968,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -268032,6 +268392,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -271437,6 +271821,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -274465,6 +274873,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -282215,6 +282647,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -286992,6 +287448,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -317236,6 +317716,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -504281,6 +504785,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "type": "string" }, diff --git a/src/rest/data/ghes-3.17-2022-11-28/schema.json b/src/rest/data/ghes-3.17-2022-11-28/schema.json index 1e68502a775b..e37fd76ab6b8 100644 --- a/src/rest/data/ghes-3.17-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.17-2022-11-28/schema.json @@ -47140,6 +47140,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -50964,6 +50988,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -54782,6 +54830,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -58598,6 +58670,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -62400,6 +62496,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -66226,6 +66346,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -70028,6 +70172,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -73841,6 +74009,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -77654,6 +77846,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -249972,6 +250188,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -253187,6 +253427,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -256324,6 +256588,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -259394,6 +259682,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -262430,6 +262742,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -265539,6 +265875,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -268939,6 +269299,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -272344,6 +272728,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -275372,6 +275780,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -283122,6 +283554,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -287899,6 +288355,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -318143,6 +318623,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -508631,6 +509135,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "type": "string" }, diff --git a/src/rest/lib/config.json b/src/rest/lib/config.json index 22e916aaa14c..c85e05058548 100644 --- a/src/rest/lib/config.json +++ b/src/rest/lib/config.json @@ -44,5 +44,5 @@ ] } }, - "sha": "389c5166eda781b7e2ce7e5d6f44ceabf895a5bb" + "sha": "666b21169e1897d67a032c0921ebe66432f1c93e" } \ No newline at end of file diff --git a/src/webhooks/data/fpt/schema.json b/src/webhooks/data/fpt/schema.json index e2b94c168ee4..63fe8a1335d5 100644 --- a/src/webhooks/data/fpt/schema.json +++ b/src/webhooks/data/fpt/schema.json @@ -51681,6 +51681,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -52637,6 +52668,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -53615,6 +53677,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -55845,6 +55938,37 @@ "isRequired": true } ] + }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] } ] }, @@ -57801,6 +57925,37 @@ "isRequired": true } ] + }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] } ] }, @@ -60618,6 +60773,37 @@ "isRequired": true } ] + }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] } ] }, @@ -62574,6 +62760,37 @@ "isRequired": true } ] + }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] } ] }, @@ -65391,6 +65608,37 @@ "isRequired": true } ] + }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] } ] }, @@ -68153,6 +68401,37 @@ "isRequired": true } ] + }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] } ] }, @@ -70164,6 +70443,37 @@ "isRequired": true } ] + }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] } ] }, @@ -72926,6 +73236,37 @@ "isRequired": true } ] + }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] } ] }, @@ -74289,6 +74630,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -75069,6 +75441,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -76519,6 +76922,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -77921,6 +78355,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -79636,6 +80101,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -81138,6 +81634,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -82597,6 +83124,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -83998,6 +84556,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -85651,6 +86240,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -87790,6 +88410,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -89238,6 +89889,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -90640,6 +91322,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -92082,6 +92795,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -94225,6 +94969,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -95676,6 +96451,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -97318,6 +98124,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -98770,6 +99607,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -100229,6 +101097,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -101677,6 +102576,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -103128,6 +104058,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -118330,6 +119291,219 @@ "description": "" } ] + }, + { + "type": "string", + "name": "state", + "description": "", + "enum": [ + "open", + "closed" + ] + }, + { + "type": "object", + "name": "latest_status_update", + "description": "

An status update belonging to a project

", + "childParamsGroups": [ + { + "type": "number", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "project_node_id", + "description": "" + }, + { + "type": "object", + "name": "creator", + "description": "

A GitHub user.

", + "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": "user_view_type", + "description": "" + } + ] + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "status", + "description": "", + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE", + null + ] + }, + { + "type": "string", + "name": "start_date", + "description": "" + }, + { + "type": "string", + "name": "target_date", + "description": "" + }, + { + "type": "string or null", + "name": "body", + "description": "

Body of the status update

" + } + ] + }, + { + "type": "boolean", + "name": "is_template", + "description": "

Whether this project is a template

" } ] }, @@ -118858,6 +120032,219 @@ "description": "" } ] + }, + { + "type": "string", + "name": "state", + "description": "", + "enum": [ + "open", + "closed" + ] + }, + { + "type": "object", + "name": "latest_status_update", + "description": "

An status update belonging to a project

", + "childParamsGroups": [ + { + "type": "number", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "project_node_id", + "description": "" + }, + { + "type": "object", + "name": "creator", + "description": "

A GitHub user.

", + "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": "user_view_type", + "description": "" + } + ] + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "status", + "description": "", + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE", + null + ] + }, + { + "type": "string", + "name": "start_date", + "description": "" + }, + { + "type": "string", + "name": "target_date", + "description": "" + }, + { + "type": "string or null", + "name": "body", + "description": "

Body of the status update

" + } + ] + }, + { + "type": "boolean", + "name": "is_template", + "description": "

Whether this project is a template

" } ] }, @@ -119386,6 +120773,219 @@ "description": "" } ] + }, + { + "type": "string", + "name": "state", + "description": "", + "enum": [ + "open", + "closed" + ] + }, + { + "type": "object", + "name": "latest_status_update", + "description": "

An status update belonging to a project

", + "childParamsGroups": [ + { + "type": "number", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "project_node_id", + "description": "" + }, + { + "type": "object", + "name": "creator", + "description": "

A GitHub user.

", + "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": "user_view_type", + "description": "" + } + ] + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "status", + "description": "", + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE", + null + ] + }, + { + "type": "string", + "name": "start_date", + "description": "" + }, + { + "type": "string", + "name": "target_date", + "description": "" + }, + { + "type": "string or null", + "name": "body", + "description": "

Body of the status update

" + } + ] + }, + { + "type": "boolean", + "name": "is_template", + "description": "

Whether this project is a template

" } ] }, @@ -119991,6 +121591,219 @@ "description": "" } ] + }, + { + "type": "string", + "name": "state", + "description": "", + "enum": [ + "open", + "closed" + ] + }, + { + "type": "object", + "name": "latest_status_update", + "description": "

An status update belonging to a project

", + "childParamsGroups": [ + { + "type": "number", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "project_node_id", + "description": "" + }, + { + "type": "object", + "name": "creator", + "description": "

A GitHub user.

", + "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": "user_view_type", + "description": "" + } + ] + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "status", + "description": "", + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE", + null + ] + }, + { + "type": "string", + "name": "start_date", + "description": "" + }, + { + "type": "string", + "name": "target_date", + "description": "" + }, + { + "type": "string or null", + "name": "body", + "description": "

Body of the status update

" + } + ] + }, + { + "type": "boolean", + "name": "is_template", + "description": "

Whether this project is a template

" } ] }, @@ -120519,6 +122332,219 @@ "description": "" } ] + }, + { + "type": "string", + "name": "state", + "description": "", + "enum": [ + "open", + "closed" + ] + }, + { + "type": "object", + "name": "latest_status_update", + "description": "

An status update belonging to a project

", + "childParamsGroups": [ + { + "type": "number", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "project_node_id", + "description": "" + }, + { + "type": "object", + "name": "creator", + "description": "

A GitHub user.

", + "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": "user_view_type", + "description": "" + } + ] + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "status", + "description": "", + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE", + null + ] + }, + { + "type": "string", + "name": "start_date", + "description": "" + }, + { + "type": "string", + "name": "target_date", + "description": "" + }, + { + "type": "string or null", + "name": "body", + "description": "

Body of the status update

" + } + ] + }, + { + "type": "boolean", + "name": "is_template", + "description": "

Whether this project is a template

" } ] }, @@ -249576,6 +251602,37 @@ "isRequired": true } ] + }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] } ] }, @@ -252338,6 +254395,37 @@ "isRequired": true } ] + }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] } ] }, @@ -254346,6 +256434,37 @@ "isRequired": true } ] + }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] } ] }, @@ -257108,6 +259227,37 @@ "isRequired": true } ] + }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] } ] }, @@ -259116,6 +261266,37 @@ "isRequired": true } ] + }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] } ] }, @@ -261878,6 +264059,37 @@ "isRequired": true } ] + }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] } ] }, @@ -263886,6 +266098,37 @@ "isRequired": true } ] + }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] } ] }, @@ -266648,6 +268891,37 @@ "isRequired": true } ] + }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] } ] }, diff --git a/src/webhooks/data/ghec/schema.json b/src/webhooks/data/ghec/schema.json index 04ccce16a9c5..1426f4fc4734 100644 --- a/src/webhooks/data/ghec/schema.json +++ b/src/webhooks/data/ghec/schema.json @@ -58130,6 +58130,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -59086,6 +59117,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -60064,6 +60126,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -62294,6 +62387,37 @@ "isRequired": true } ] + }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] } ] }, @@ -64250,6 +64374,37 @@ "isRequired": true } ] + }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] } ] }, @@ -67067,6 +67222,37 @@ "isRequired": true } ] + }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] } ] }, @@ -69023,6 +69209,37 @@ "isRequired": true } ] + }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] } ] }, @@ -71840,6 +72057,37 @@ "isRequired": true } ] + }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] } ] }, @@ -74602,6 +74850,37 @@ "isRequired": true } ] + }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] } ] }, @@ -76613,6 +76892,37 @@ "isRequired": true } ] + }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] } ] }, @@ -79375,6 +79685,37 @@ "isRequired": true } ] + }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] } ] }, @@ -80738,6 +81079,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -81518,6 +81890,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -82968,6 +83371,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -84370,6 +84804,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -86085,6 +86550,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -87587,6 +88083,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -89046,6 +89573,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -90447,6 +91005,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -92100,6 +92689,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -94239,6 +94859,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -95687,6 +96338,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -97089,6 +97771,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -98531,6 +99244,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -100674,6 +101418,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -102125,6 +102900,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -103767,6 +104573,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -105219,6 +106056,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -106678,6 +107546,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -108126,6 +109025,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -109577,6 +110507,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -124779,6 +125740,219 @@ "description": "" } ] + }, + { + "type": "string", + "name": "state", + "description": "", + "enum": [ + "open", + "closed" + ] + }, + { + "type": "object", + "name": "latest_status_update", + "description": "

An status update belonging to a project

", + "childParamsGroups": [ + { + "type": "number", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "project_node_id", + "description": "" + }, + { + "type": "object", + "name": "creator", + "description": "

A GitHub user.

", + "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": "user_view_type", + "description": "" + } + ] + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "status", + "description": "", + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE", + null + ] + }, + { + "type": "string", + "name": "start_date", + "description": "" + }, + { + "type": "string", + "name": "target_date", + "description": "" + }, + { + "type": "string or null", + "name": "body", + "description": "

Body of the status update

" + } + ] + }, + { + "type": "boolean", + "name": "is_template", + "description": "

Whether this project is a template

" } ] }, @@ -125307,6 +126481,219 @@ "description": "" } ] + }, + { + "type": "string", + "name": "state", + "description": "", + "enum": [ + "open", + "closed" + ] + }, + { + "type": "object", + "name": "latest_status_update", + "description": "

An status update belonging to a project

", + "childParamsGroups": [ + { + "type": "number", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "project_node_id", + "description": "" + }, + { + "type": "object", + "name": "creator", + "description": "

A GitHub user.

", + "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": "user_view_type", + "description": "" + } + ] + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "status", + "description": "", + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE", + null + ] + }, + { + "type": "string", + "name": "start_date", + "description": "" + }, + { + "type": "string", + "name": "target_date", + "description": "" + }, + { + "type": "string or null", + "name": "body", + "description": "

Body of the status update

" + } + ] + }, + { + "type": "boolean", + "name": "is_template", + "description": "

Whether this project is a template

" } ] }, @@ -125835,6 +127222,219 @@ "description": "" } ] + }, + { + "type": "string", + "name": "state", + "description": "", + "enum": [ + "open", + "closed" + ] + }, + { + "type": "object", + "name": "latest_status_update", + "description": "

An status update belonging to a project

", + "childParamsGroups": [ + { + "type": "number", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "project_node_id", + "description": "" + }, + { + "type": "object", + "name": "creator", + "description": "

A GitHub user.

", + "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": "user_view_type", + "description": "" + } + ] + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "status", + "description": "", + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE", + null + ] + }, + { + "type": "string", + "name": "start_date", + "description": "" + }, + { + "type": "string", + "name": "target_date", + "description": "" + }, + { + "type": "string or null", + "name": "body", + "description": "

Body of the status update

" + } + ] + }, + { + "type": "boolean", + "name": "is_template", + "description": "

Whether this project is a template

" } ] }, @@ -126440,6 +128040,219 @@ "description": "" } ] + }, + { + "type": "string", + "name": "state", + "description": "", + "enum": [ + "open", + "closed" + ] + }, + { + "type": "object", + "name": "latest_status_update", + "description": "

An status update belonging to a project

", + "childParamsGroups": [ + { + "type": "number", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "project_node_id", + "description": "" + }, + { + "type": "object", + "name": "creator", + "description": "

A GitHub user.

", + "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": "user_view_type", + "description": "" + } + ] + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "status", + "description": "", + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE", + null + ] + }, + { + "type": "string", + "name": "start_date", + "description": "" + }, + { + "type": "string", + "name": "target_date", + "description": "" + }, + { + "type": "string or null", + "name": "body", + "description": "

Body of the status update

" + } + ] + }, + { + "type": "boolean", + "name": "is_template", + "description": "

Whether this project is a template

" } ] }, @@ -126968,6 +128781,219 @@ "description": "" } ] + }, + { + "type": "string", + "name": "state", + "description": "", + "enum": [ + "open", + "closed" + ] + }, + { + "type": "object", + "name": "latest_status_update", + "description": "

An status update belonging to a project

", + "childParamsGroups": [ + { + "type": "number", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "project_node_id", + "description": "" + }, + { + "type": "object", + "name": "creator", + "description": "

A GitHub user.

", + "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": "user_view_type", + "description": "" + } + ] + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "status", + "description": "", + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE", + null + ] + }, + { + "type": "string", + "name": "start_date", + "description": "" + }, + { + "type": "string", + "name": "target_date", + "description": "" + }, + { + "type": "string or null", + "name": "body", + "description": "

Body of the status update

" + } + ] + }, + { + "type": "boolean", + "name": "is_template", + "description": "

Whether this project is a template

" } ] }, @@ -256044,6 +258070,37 @@ "isRequired": true } ] + }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] } ] }, @@ -258806,6 +260863,37 @@ "isRequired": true } ] + }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] } ] }, @@ -260814,6 +262902,37 @@ "isRequired": true } ] + }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] } ] }, @@ -263576,6 +265695,37 @@ "isRequired": true } ] + }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] } ] }, @@ -265584,6 +267734,37 @@ "isRequired": true } ] + }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] } ] }, @@ -268346,6 +270527,37 @@ "isRequired": true } ] + }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] } ] }, @@ -270354,6 +272566,37 @@ "isRequired": true } ] + }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] } ] }, @@ -273116,6 +275359,37 @@ "isRequired": true } ] + }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] } ] }, diff --git a/src/webhooks/data/ghes-3.14/schema.json b/src/webhooks/data/ghes-3.14/schema.json index 8f30e2df2477..2d8e867b2c6b 100644 --- a/src/webhooks/data/ghes-3.14/schema.json +++ b/src/webhooks/data/ghes-3.14/schema.json @@ -53034,6 +53034,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -53990,6 +54021,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -54968,6 +55030,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -56548,6 +56641,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -57328,6 +57452,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -58778,6 +58933,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -60180,6 +60366,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -61895,6 +62112,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -63397,6 +63645,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -64856,6 +65135,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -66257,6 +66567,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -67910,6 +68251,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -70049,6 +70421,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -71497,6 +71900,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -72899,6 +73333,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -74341,6 +74806,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -76484,6 +76980,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -78061,6 +78588,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -79513,6 +80071,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -80972,6 +81561,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -82420,6 +83040,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -95101,6 +95752,219 @@ "description": "" } ] + }, + { + "type": "string", + "name": "state", + "description": "", + "enum": [ + "open", + "closed" + ] + }, + { + "type": "object", + "name": "latest_status_update", + "description": "

An status update belonging to a project

", + "childParamsGroups": [ + { + "type": "number", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "project_node_id", + "description": "" + }, + { + "type": "object", + "name": "creator", + "description": "

A GitHub user.

", + "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": "user_view_type", + "description": "" + } + ] + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "status", + "description": "", + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE", + null + ] + }, + { + "type": "string", + "name": "start_date", + "description": "" + }, + { + "type": "string", + "name": "target_date", + "description": "" + }, + { + "type": "string or null", + "name": "body", + "description": "

Body of the status update

" + } + ] + }, + { + "type": "boolean", + "name": "is_template", + "description": "

Whether this project is a template

" } ] }, @@ -95629,6 +96493,219 @@ "description": "" } ] + }, + { + "type": "string", + "name": "state", + "description": "", + "enum": [ + "open", + "closed" + ] + }, + { + "type": "object", + "name": "latest_status_update", + "description": "

An status update belonging to a project

", + "childParamsGroups": [ + { + "type": "number", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "project_node_id", + "description": "" + }, + { + "type": "object", + "name": "creator", + "description": "

A GitHub user.

", + "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": "user_view_type", + "description": "" + } + ] + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "status", + "description": "", + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE", + null + ] + }, + { + "type": "string", + "name": "start_date", + "description": "" + }, + { + "type": "string", + "name": "target_date", + "description": "" + }, + { + "type": "string or null", + "name": "body", + "description": "

Body of the status update

" + } + ] + }, + { + "type": "boolean", + "name": "is_template", + "description": "

Whether this project is a template

" } ] }, @@ -96157,6 +97234,219 @@ "description": "" } ] + }, + { + "type": "string", + "name": "state", + "description": "", + "enum": [ + "open", + "closed" + ] + }, + { + "type": "object", + "name": "latest_status_update", + "description": "

An status update belonging to a project

", + "childParamsGroups": [ + { + "type": "number", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "project_node_id", + "description": "" + }, + { + "type": "object", + "name": "creator", + "description": "

A GitHub user.

", + "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": "user_view_type", + "description": "" + } + ] + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "status", + "description": "", + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE", + null + ] + }, + { + "type": "string", + "name": "start_date", + "description": "" + }, + { + "type": "string", + "name": "target_date", + "description": "" + }, + { + "type": "string or null", + "name": "body", + "description": "

Body of the status update

" + } + ] + }, + { + "type": "boolean", + "name": "is_template", + "description": "

Whether this project is a template

" } ] }, @@ -96762,6 +98052,219 @@ "description": "" } ] + }, + { + "type": "string", + "name": "state", + "description": "", + "enum": [ + "open", + "closed" + ] + }, + { + "type": "object", + "name": "latest_status_update", + "description": "

An status update belonging to a project

", + "childParamsGroups": [ + { + "type": "number", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "project_node_id", + "description": "" + }, + { + "type": "object", + "name": "creator", + "description": "

A GitHub user.

", + "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": "user_view_type", + "description": "" + } + ] + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "status", + "description": "", + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE", + null + ] + }, + { + "type": "string", + "name": "start_date", + "description": "" + }, + { + "type": "string", + "name": "target_date", + "description": "" + }, + { + "type": "string or null", + "name": "body", + "description": "

Body of the status update

" + } + ] + }, + { + "type": "boolean", + "name": "is_template", + "description": "

Whether this project is a template

" } ] }, @@ -97290,6 +98793,219 @@ "description": "" } ] + }, + { + "type": "string", + "name": "state", + "description": "", + "enum": [ + "open", + "closed" + ] + }, + { + "type": "object", + "name": "latest_status_update", + "description": "

An status update belonging to a project

", + "childParamsGroups": [ + { + "type": "number", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "project_node_id", + "description": "" + }, + { + "type": "object", + "name": "creator", + "description": "

A GitHub user.

", + "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": "user_view_type", + "description": "" + } + ] + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "status", + "description": "", + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE", + null + ] + }, + { + "type": "string", + "name": "start_date", + "description": "" + }, + { + "type": "string", + "name": "target_date", + "description": "" + }, + { + "type": "string or null", + "name": "body", + "description": "

Body of the status update

" + } + ] + }, + { + "type": "boolean", + "name": "is_template", + "description": "

Whether this project is a template

" } ] }, diff --git a/src/webhooks/data/ghes-3.15/schema.json b/src/webhooks/data/ghes-3.15/schema.json index f62e41bb06f6..44e6a6dfcee6 100644 --- a/src/webhooks/data/ghes-3.15/schema.json +++ b/src/webhooks/data/ghes-3.15/schema.json @@ -53217,6 +53217,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -54173,6 +54204,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -55151,6 +55213,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -56731,6 +56824,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -57511,6 +57635,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -58961,6 +59116,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -60363,6 +60549,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -62078,6 +62295,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -63580,6 +63828,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -65039,6 +65318,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -66440,6 +66750,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -68093,6 +68434,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -70232,6 +70604,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -71680,6 +72083,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -73082,6 +73516,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -74524,6 +74989,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -76667,6 +77163,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -78244,6 +78771,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -79696,6 +80254,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -81155,6 +81744,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -82603,6 +83223,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -95284,6 +95935,219 @@ "description": "" } ] + }, + { + "type": "string", + "name": "state", + "description": "", + "enum": [ + "open", + "closed" + ] + }, + { + "type": "object", + "name": "latest_status_update", + "description": "

An status update belonging to a project

", + "childParamsGroups": [ + { + "type": "number", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "project_node_id", + "description": "" + }, + { + "type": "object", + "name": "creator", + "description": "

A GitHub user.

", + "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": "user_view_type", + "description": "" + } + ] + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "status", + "description": "", + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE", + null + ] + }, + { + "type": "string", + "name": "start_date", + "description": "" + }, + { + "type": "string", + "name": "target_date", + "description": "" + }, + { + "type": "string or null", + "name": "body", + "description": "

Body of the status update

" + } + ] + }, + { + "type": "boolean", + "name": "is_template", + "description": "

Whether this project is a template

" } ] }, @@ -95812,6 +96676,219 @@ "description": "" } ] + }, + { + "type": "string", + "name": "state", + "description": "", + "enum": [ + "open", + "closed" + ] + }, + { + "type": "object", + "name": "latest_status_update", + "description": "

An status update belonging to a project

", + "childParamsGroups": [ + { + "type": "number", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "project_node_id", + "description": "" + }, + { + "type": "object", + "name": "creator", + "description": "

A GitHub user.

", + "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": "user_view_type", + "description": "" + } + ] + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "status", + "description": "", + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE", + null + ] + }, + { + "type": "string", + "name": "start_date", + "description": "" + }, + { + "type": "string", + "name": "target_date", + "description": "" + }, + { + "type": "string or null", + "name": "body", + "description": "

Body of the status update

" + } + ] + }, + { + "type": "boolean", + "name": "is_template", + "description": "

Whether this project is a template

" } ] }, @@ -96340,6 +97417,219 @@ "description": "" } ] + }, + { + "type": "string", + "name": "state", + "description": "", + "enum": [ + "open", + "closed" + ] + }, + { + "type": "object", + "name": "latest_status_update", + "description": "

An status update belonging to a project

", + "childParamsGroups": [ + { + "type": "number", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "project_node_id", + "description": "" + }, + { + "type": "object", + "name": "creator", + "description": "

A GitHub user.

", + "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": "user_view_type", + "description": "" + } + ] + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "status", + "description": "", + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE", + null + ] + }, + { + "type": "string", + "name": "start_date", + "description": "" + }, + { + "type": "string", + "name": "target_date", + "description": "" + }, + { + "type": "string or null", + "name": "body", + "description": "

Body of the status update

" + } + ] + }, + { + "type": "boolean", + "name": "is_template", + "description": "

Whether this project is a template

" } ] }, @@ -96945,6 +98235,219 @@ "description": "" } ] + }, + { + "type": "string", + "name": "state", + "description": "", + "enum": [ + "open", + "closed" + ] + }, + { + "type": "object", + "name": "latest_status_update", + "description": "

An status update belonging to a project

", + "childParamsGroups": [ + { + "type": "number", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "project_node_id", + "description": "" + }, + { + "type": "object", + "name": "creator", + "description": "

A GitHub user.

", + "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": "user_view_type", + "description": "" + } + ] + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "status", + "description": "", + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE", + null + ] + }, + { + "type": "string", + "name": "start_date", + "description": "" + }, + { + "type": "string", + "name": "target_date", + "description": "" + }, + { + "type": "string or null", + "name": "body", + "description": "

Body of the status update

" + } + ] + }, + { + "type": "boolean", + "name": "is_template", + "description": "

Whether this project is a template

" } ] }, @@ -97473,6 +98976,219 @@ "description": "" } ] + }, + { + "type": "string", + "name": "state", + "description": "", + "enum": [ + "open", + "closed" + ] + }, + { + "type": "object", + "name": "latest_status_update", + "description": "

An status update belonging to a project

", + "childParamsGroups": [ + { + "type": "number", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "project_node_id", + "description": "" + }, + { + "type": "object", + "name": "creator", + "description": "

A GitHub user.

", + "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": "user_view_type", + "description": "" + } + ] + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "status", + "description": "", + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE", + null + ] + }, + { + "type": "string", + "name": "start_date", + "description": "" + }, + { + "type": "string", + "name": "target_date", + "description": "" + }, + { + "type": "string or null", + "name": "body", + "description": "

Body of the status update

" + } + ] + }, + { + "type": "boolean", + "name": "is_template", + "description": "

Whether this project is a template

" } ] }, diff --git a/src/webhooks/data/ghes-3.16/schema.json b/src/webhooks/data/ghes-3.16/schema.json index 415271f74ef6..42f9bf110c0b 100644 --- a/src/webhooks/data/ghes-3.16/schema.json +++ b/src/webhooks/data/ghes-3.16/schema.json @@ -55221,6 +55221,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -56177,6 +56208,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -57155,6 +57217,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -58735,6 +58828,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -59515,6 +59639,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -60965,6 +61120,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -62367,6 +62553,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -64082,6 +64299,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -65584,6 +65832,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -67043,6 +67322,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -68444,6 +68754,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -70097,6 +70438,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -72236,6 +72608,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -73684,6 +74087,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -75086,6 +75520,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -76528,6 +76993,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -78671,6 +79167,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -80248,6 +80775,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -81700,6 +82258,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -83159,6 +83748,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -84607,6 +85227,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -97288,6 +97939,219 @@ "description": "" } ] + }, + { + "type": "string", + "name": "state", + "description": "", + "enum": [ + "open", + "closed" + ] + }, + { + "type": "object", + "name": "latest_status_update", + "description": "

An status update belonging to a project

", + "childParamsGroups": [ + { + "type": "number", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "project_node_id", + "description": "" + }, + { + "type": "object", + "name": "creator", + "description": "

A GitHub user.

", + "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": "user_view_type", + "description": "" + } + ] + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "status", + "description": "", + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE", + null + ] + }, + { + "type": "string", + "name": "start_date", + "description": "" + }, + { + "type": "string", + "name": "target_date", + "description": "" + }, + { + "type": "string or null", + "name": "body", + "description": "

Body of the status update

" + } + ] + }, + { + "type": "boolean", + "name": "is_template", + "description": "

Whether this project is a template

" } ] }, @@ -97816,6 +98680,219 @@ "description": "" } ] + }, + { + "type": "string", + "name": "state", + "description": "", + "enum": [ + "open", + "closed" + ] + }, + { + "type": "object", + "name": "latest_status_update", + "description": "

An status update belonging to a project

", + "childParamsGroups": [ + { + "type": "number", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "project_node_id", + "description": "" + }, + { + "type": "object", + "name": "creator", + "description": "

A GitHub user.

", + "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": "user_view_type", + "description": "" + } + ] + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "status", + "description": "", + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE", + null + ] + }, + { + "type": "string", + "name": "start_date", + "description": "" + }, + { + "type": "string", + "name": "target_date", + "description": "" + }, + { + "type": "string or null", + "name": "body", + "description": "

Body of the status update

" + } + ] + }, + { + "type": "boolean", + "name": "is_template", + "description": "

Whether this project is a template

" } ] }, @@ -98344,6 +99421,219 @@ "description": "" } ] + }, + { + "type": "string", + "name": "state", + "description": "", + "enum": [ + "open", + "closed" + ] + }, + { + "type": "object", + "name": "latest_status_update", + "description": "

An status update belonging to a project

", + "childParamsGroups": [ + { + "type": "number", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "project_node_id", + "description": "" + }, + { + "type": "object", + "name": "creator", + "description": "

A GitHub user.

", + "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": "user_view_type", + "description": "" + } + ] + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "status", + "description": "", + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE", + null + ] + }, + { + "type": "string", + "name": "start_date", + "description": "" + }, + { + "type": "string", + "name": "target_date", + "description": "" + }, + { + "type": "string or null", + "name": "body", + "description": "

Body of the status update

" + } + ] + }, + { + "type": "boolean", + "name": "is_template", + "description": "

Whether this project is a template

" } ] }, @@ -98949,6 +100239,219 @@ "description": "" } ] + }, + { + "type": "string", + "name": "state", + "description": "", + "enum": [ + "open", + "closed" + ] + }, + { + "type": "object", + "name": "latest_status_update", + "description": "

An status update belonging to a project

", + "childParamsGroups": [ + { + "type": "number", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "project_node_id", + "description": "" + }, + { + "type": "object", + "name": "creator", + "description": "

A GitHub user.

", + "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": "user_view_type", + "description": "" + } + ] + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "status", + "description": "", + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE", + null + ] + }, + { + "type": "string", + "name": "start_date", + "description": "" + }, + { + "type": "string", + "name": "target_date", + "description": "" + }, + { + "type": "string or null", + "name": "body", + "description": "

Body of the status update

" + } + ] + }, + { + "type": "boolean", + "name": "is_template", + "description": "

Whether this project is a template

" } ] }, @@ -99477,6 +100980,219 @@ "description": "" } ] + }, + { + "type": "string", + "name": "state", + "description": "", + "enum": [ + "open", + "closed" + ] + }, + { + "type": "object", + "name": "latest_status_update", + "description": "

An status update belonging to a project

", + "childParamsGroups": [ + { + "type": "number", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "project_node_id", + "description": "" + }, + { + "type": "object", + "name": "creator", + "description": "

A GitHub user.

", + "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": "user_view_type", + "description": "" + } + ] + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "status", + "description": "", + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE", + null + ] + }, + { + "type": "string", + "name": "start_date", + "description": "" + }, + { + "type": "string", + "name": "target_date", + "description": "" + }, + { + "type": "string or null", + "name": "body", + "description": "

Body of the status update

" + } + ] + }, + { + "type": "boolean", + "name": "is_template", + "description": "

Whether this project is a template

" } ] }, diff --git a/src/webhooks/data/ghes-3.17/schema.json b/src/webhooks/data/ghes-3.17/schema.json index 04cde932c618..2cb48bb18382 100644 --- a/src/webhooks/data/ghes-3.17/schema.json +++ b/src/webhooks/data/ghes-3.17/schema.json @@ -57920,6 +57920,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -58876,6 +58907,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -59854,6 +59916,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -61434,6 +61527,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -62214,6 +62338,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -63664,6 +63819,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -65066,6 +65252,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -66781,6 +66998,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -68283,6 +68531,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -69742,6 +70021,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -71143,6 +71453,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -72796,6 +73137,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -74935,6 +75307,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -76383,6 +76786,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -77785,6 +78219,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -79227,6 +79692,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -81370,6 +81866,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -82947,6 +83474,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -84399,6 +84957,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -85858,6 +86447,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -87306,6 +87926,37 @@ } ] }, + { + "type": "object", + "name": "issue_dependencies_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "blocking", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocked_by", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_blocking", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", "name": "state", @@ -99987,6 +100638,219 @@ "description": "" } ] + }, + { + "type": "string", + "name": "state", + "description": "", + "enum": [ + "open", + "closed" + ] + }, + { + "type": "object", + "name": "latest_status_update", + "description": "

An status update belonging to a project

", + "childParamsGroups": [ + { + "type": "number", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "project_node_id", + "description": "" + }, + { + "type": "object", + "name": "creator", + "description": "

A GitHub user.

", + "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": "user_view_type", + "description": "" + } + ] + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "status", + "description": "", + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE", + null + ] + }, + { + "type": "string", + "name": "start_date", + "description": "" + }, + { + "type": "string", + "name": "target_date", + "description": "" + }, + { + "type": "string or null", + "name": "body", + "description": "

Body of the status update

" + } + ] + }, + { + "type": "boolean", + "name": "is_template", + "description": "

Whether this project is a template

" } ] }, @@ -100515,6 +101379,219 @@ "description": "" } ] + }, + { + "type": "string", + "name": "state", + "description": "", + "enum": [ + "open", + "closed" + ] + }, + { + "type": "object", + "name": "latest_status_update", + "description": "

An status update belonging to a project

", + "childParamsGroups": [ + { + "type": "number", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "project_node_id", + "description": "" + }, + { + "type": "object", + "name": "creator", + "description": "

A GitHub user.

", + "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": "user_view_type", + "description": "" + } + ] + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "status", + "description": "", + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE", + null + ] + }, + { + "type": "string", + "name": "start_date", + "description": "" + }, + { + "type": "string", + "name": "target_date", + "description": "" + }, + { + "type": "string or null", + "name": "body", + "description": "

Body of the status update

" + } + ] + }, + { + "type": "boolean", + "name": "is_template", + "description": "

Whether this project is a template

" } ] }, @@ -101043,6 +102120,219 @@ "description": "" } ] + }, + { + "type": "string", + "name": "state", + "description": "", + "enum": [ + "open", + "closed" + ] + }, + { + "type": "object", + "name": "latest_status_update", + "description": "

An status update belonging to a project

", + "childParamsGroups": [ + { + "type": "number", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "project_node_id", + "description": "" + }, + { + "type": "object", + "name": "creator", + "description": "

A GitHub user.

", + "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": "user_view_type", + "description": "" + } + ] + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "status", + "description": "", + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE", + null + ] + }, + { + "type": "string", + "name": "start_date", + "description": "" + }, + { + "type": "string", + "name": "target_date", + "description": "" + }, + { + "type": "string or null", + "name": "body", + "description": "

Body of the status update

" + } + ] + }, + { + "type": "boolean", + "name": "is_template", + "description": "

Whether this project is a template

" } ] }, @@ -101648,6 +102938,219 @@ "description": "" } ] + }, + { + "type": "string", + "name": "state", + "description": "", + "enum": [ + "open", + "closed" + ] + }, + { + "type": "object", + "name": "latest_status_update", + "description": "

An status update belonging to a project

", + "childParamsGroups": [ + { + "type": "number", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "project_node_id", + "description": "" + }, + { + "type": "object", + "name": "creator", + "description": "

A GitHub user.

", + "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": "user_view_type", + "description": "" + } + ] + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "status", + "description": "", + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE", + null + ] + }, + { + "type": "string", + "name": "start_date", + "description": "" + }, + { + "type": "string", + "name": "target_date", + "description": "" + }, + { + "type": "string or null", + "name": "body", + "description": "

Body of the status update

" + } + ] + }, + { + "type": "boolean", + "name": "is_template", + "description": "

Whether this project is a template

" } ] }, @@ -102176,6 +103679,219 @@ "description": "" } ] + }, + { + "type": "string", + "name": "state", + "description": "", + "enum": [ + "open", + "closed" + ] + }, + { + "type": "object", + "name": "latest_status_update", + "description": "

An status update belonging to a project

", + "childParamsGroups": [ + { + "type": "number", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "project_node_id", + "description": "" + }, + { + "type": "object", + "name": "creator", + "description": "

A GitHub user.

", + "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": "user_view_type", + "description": "" + } + ] + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "status", + "description": "", + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE", + null + ] + }, + { + "type": "string", + "name": "start_date", + "description": "" + }, + { + "type": "string", + "name": "target_date", + "description": "" + }, + { + "type": "string or null", + "name": "body", + "description": "

Body of the status update

" + } + ] + }, + { + "type": "boolean", + "name": "is_template", + "description": "

Whether this project is a template

" } ] }, diff --git a/src/webhooks/lib/config.json b/src/webhooks/lib/config.json index 81173035d98a..0cca48cbd42d 100644 --- a/src/webhooks/lib/config.json +++ b/src/webhooks/lib/config.json @@ -1,3 +1,3 @@ { - "sha": "389c5166eda781b7e2ce7e5d6f44ceabf895a5bb" + "sha": "666b21169e1897d67a032c0921ebe66432f1c93e" } \ No newline at end of file