diff --git a/content/rest/dependency-graph/dependency-review.md b/content/rest/dependency-graph/dependency-review.md index b032e74c29..59bbcc6d89 100644 --- a/content/rest/dependency-graph/dependency-review.md +++ b/content/rest/dependency-graph/dependency-review.md @@ -4,7 +4,7 @@ intro: Use the REST API to interact with dependency changes. versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖 fpt: '*' ghec: '*' - ghes: '>=3.6' + ghes: '*' topics: - API allowTitleToDifferFromFilename: true diff --git a/content/rest/enterprise-admin/scim.md b/content/rest/enterprise-admin/scim.md index c078849ff9..0a88d6c1b5 100644 --- a/content/rest/enterprise-admin/scim.md +++ b/content/rest/enterprise-admin/scim.md @@ -2,7 +2,7 @@ title: SCIM intro: Use the REST API to automate user creation and team memberships with SCIM. versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖 - ghes: '>=3.6' + ghes: '*' topics: - API autogenerated: rest diff --git a/content/rest/teams/external-groups.md b/content/rest/teams/external-groups.md index 21af60e0d2..a59e966acd 100644 --- a/content/rest/teams/external-groups.md +++ b/content/rest/teams/external-groups.md @@ -7,7 +7,7 @@ intro: >- versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖 ghae: '*' ghec: '*' - ghes: '>=3.6' + ghes: '*' topics: - API autogenerated: rest diff --git a/src/github-apps/lib/config.json b/src/github-apps/lib/config.json index c72e7c5bb4..945e518306 100644 --- a/src/github-apps/lib/config.json +++ b/src/github-apps/lib/config.json @@ -60,5 +60,5 @@ "2022-11-28" ] }, - "sha": "2b5555bb39f20fc261e2da7b32825391518a900a" + "sha": "4bcf31ad7b9b05793f9857f379fcfc1f4d8bb06b" } \ No newline at end of file diff --git a/src/rest/data/fpt-2022-11-28/schema.json b/src/rest/data/fpt-2022-11-28/schema.json index 80906a25eb..45cbe4181f 100644 --- a/src/rest/data/fpt-2022-11-28/schema.json +++ b/src/rest/data/fpt-2022-11-28/schema.json @@ -72839,7 +72839,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -75392,7 +75392,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -88061,7 +88061,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -152797,7 +152797,7 @@ } ], "previews": [], - "descriptionHTML": "

Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the security_events scope to use this endpoint for private repositories. You can also use tokens with the public_repo scope for public repositories only. GitHub Apps must have the security_events write permission to use this endpoint.

\n

There are two places where you can upload code scanning results.

\n\n

You must compress the SARIF-formatted analysis data that you want to upload, using gzip, and then encode it as a Base64 format string. For example:

\n
gzip -c analysis-data.sarif | base64 -w0\n
\n
\nSARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable.\nTo get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
SARIF dataMaximum valuesAdditional limits
Runs per file20
Results per run25,000Only the top 5,000 results will be included, prioritized by severity.
Rules per run25,000
Tool extensions per run100
Thread Flow Locations per result10,000Only the top 1,000 Thread Flow Locations will be included, using prioritization.
Location per result1,000Only 100 locations will be included.
Tags per rule20Only 10 tags will be included.
\n

The 202 Accepted response includes an id value.\nYou can use this ID to check the status of the upload by using it in the /sarifs/{sarif_id} endpoint.\nFor more information, see \"Get information about a SARIF upload.\"

", + "descriptionHTML": "

Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the security_events scope to use this endpoint for private repositories. You can also use tokens with the public_repo scope for public repositories only. GitHub Apps must have the security_events write permission to use this endpoint.

\n

There are two places where you can upload code scanning results.

\n\n

You must compress the SARIF-formatted analysis data that you want to upload, using gzip, and then encode it as a Base64 format string. For example:

\n
gzip -c analysis-data.sarif | base64 -w0\n
\n
\nSARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable.\nTo get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
SARIF dataMaximum valuesAdditional limits
Runs per file20
Results per run25,000Only the top 5,000 results will be included, prioritized by severity.
Rules per run25,000
Tool extensions per run100
Thread Flow Locations per result10,000Only the top 1,000 Thread Flow Locations will be included, using prioritization.
Location per result1,000Only 100 locations will be included.
Tags per rule20Only 10 tags will be included.
\n

The 202 Accepted response includes an id value.\nYou can use this ID to check the status of the upload by using it in the /sarifs/{sarif_id} endpoint.\nFor more information, see \"Get information about a SARIF upload.\"

", "statusCodes": [ { "httpStatusCode": "202", @@ -152921,7 +152921,7 @@ } ], "previews": [], - "descriptionHTML": "

Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see \"Get a code scanning analysis for a repository.\" You must use an access token with the security_events scope to use this endpoint with private repos, the public_repo scope also grants permission to read security events on public repos only. GitHub Apps must have the security_events read permission to use this endpoint.

", + "descriptionHTML": "

Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see \"Get a code scanning analysis for a repository.\" You must use an access token with the security_events scope to use this endpoint with private repos, the public_repo scope also grants permission to read security events on public repos only. GitHub Apps must have the security_events read permission to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -199585,7 +199585,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -220476,7 +220476,7 @@ "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.

" + "description": "

Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an organization public key endpoint.

" }, { "type": "string", @@ -220500,7 +220500,7 @@ "type": "array of strings", "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.

" + "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.

" } ], "enabledForGitHubApps": true, @@ -221632,7 +221632,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 Set selected repositories for an organization secret and Remove selected repository from an organization secret endpoints.

", + "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 Set selected repositories for an organization secret and Remove selected repository from an organization secret endpoints.

", "isRequired": true } ], @@ -221661,7 +221661,7 @@ } ], "previews": [], - "descriptionHTML": "

Replaces all repositories for an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization permission to use this endpoint.

", + "descriptionHTML": "

Replaces all repositories for an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization permission to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", @@ -221726,7 +221726,7 @@ } ], "previews": [], - "descriptionHTML": "

Adds a repository to an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization permission to use this endpoint.

", + "descriptionHTML": "

Adds a repository to an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization permission to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", @@ -221795,7 +221795,7 @@ } ], "previews": [], - "descriptionHTML": "

Removes a repository from an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization permission to use this endpoint.

", + "descriptionHTML": "

Removes a repository from an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization permission to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", @@ -222162,7 +222162,7 @@ "type": "string", "name": "encrypted_value", "in": "body", - "description": "

Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint.

" + "description": "

Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint.

" }, { "type": "string", @@ -229075,7 +229075,126 @@ }, "response": { "statusCode": "200", - "description": "

List of deployment protection rules

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

List of deployment protection rules

", + "example": { + "total_count": 2, + "custom_deployment_protection_rules": [ + { + "id": 3, + "node_id": "IEH37kRlcGxveW1lbnRTdGF0ddiv", + "enabled": true, + "app": { + "id": 1, + "node_id": "GHT58kRlcGxveW1lbnRTdTY!bbcy", + "slug": "a-custom-app", + "integration_url": "https://api.github.com/apps/a-custom-app" + } + }, + { + "id": 4, + "node_id": "MDE2OkRlcGxveW1lbnRTdHJ41128", + "enabled": true, + "app": { + "id": 1, + "node_id": "UHVE67RlcGxveW1lbnRTdTY!jfeuy", + "slug": "another-custom-app", + "integration_url": "https://api.github.com/apps/another-custom-app" + } + } + ] + }, + "schema": { + "type": "object", + "properties": { + "total_count": { + "description": "The number of enabled custom deployment protection rules for this environment", + "type": "integer", + "examples": [ + 10 + ] + }, + "custom_deployment_protection_rules": { + "type": "array", + "items": { + "title": "Deployment protection rule", + "description": "Deployment protection rule", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier for the deployment protection rule.", + "examples": [ + 3515 + ] + }, + "node_id": { + "type": "string", + "description": "The node ID for the deployment protection rule.", + "examples": [ + "MDQ6R2F0ZTM1MTU=" + ] + }, + "enabled": { + "type": "boolean", + "description": "Whether the deployment protection rule is enabled for the environment.", + "examples": [ + true + ] + }, + "app": { + "title": "Custom deployment protection rule app", + "description": "A GitHub App that is providing a custom deployment protection rule.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the deployment protection rule integration.", + "examples": [ + 3515 + ] + }, + "slug": { + "type": "string", + "description": "The slugified name of the deployment protection rule integration.", + "examples": [ + "my-custom-app" + ] + }, + "integration_url": { + "type": "string", + "description": "The URL for the endpoint to get details about the app.", + "examples": [ + "https://api.github.com/apps/custom-app-slug" + ] + }, + "node_id": { + "type": "string", + "description": "The node ID for the deployment protection rule integration.", + "examples": [ + "MDQ6R2F0ZTM1MTU=" + ] + } + }, + "required": [ + "id", + "slug", + "integration_url", + "node_id" + ] + } + }, + "required": [ + "id", + "node_id", + "enabled", + "app" + ] + } + } + }, + "example": "../../components/examples/deployment_protection_rules.yaml" + } } } ], @@ -233887,7 +234006,7 @@ "parameters": [ { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -235802,7 +235921,7 @@ "parameters": [ { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -236370,7 +236489,7 @@ "parameters": [ { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -245895,7 +246014,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -248946,7 +249065,7 @@ } ], "previews": [], - "descriptionHTML": "

Returns an array of references from your Git database that match the supplied name. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't exist in the repository, but existing refs start with :ref, they will be returned as an array.

\n

When you use this endpoint without providing a :ref, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just heads and tags.

\n

Note: You need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"Checking mergeability of pull requests\".

\n

If you request matching references for a branch named feature but the branch feature doesn't exist, the response can still include other matching head refs that start with the word feature, such as featureA and featureB.

", + "descriptionHTML": "

Returns an array of references from your Git database that match the supplied name. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't exist in the repository, but existing refs start with :ref, they will be returned as an array.

\n

When you use this endpoint without providing a :ref, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just heads and tags.

\n

Note: You need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"Checking mergeability of pull requests\".

\n

If you request matching references for a branch named feature but the branch feature doesn't exist, the response can still include other matching head refs that start with the word feature, such as featureA and featureB.

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

Returns a single reference from your Git database. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't match an existing ref, a 404 is returned.

\n

Note: You need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"Checking mergeability of pull requests\".

", + "descriptionHTML": "

Returns a single reference from your Git database. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't match an existing ref, a 404 is returned.

\n

Note: You need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"Checking mergeability of pull requests\".

", "statusCodes": [ { "httpStatusCode": "200", @@ -251565,7 +251684,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -255009,7 +255128,7 @@ } ], "previews": [], - "descriptionHTML": "

List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the filter query parameter to fetch issues that are not\nnecessarily assigned to you.

\n

Note: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.

", + "descriptionHTML": "

List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the filter query parameter to fetch issues that are not\nnecessarily assigned to you.

\n

Note: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -255119,7 +255238,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -258530,7 +258649,7 @@ } ], "previews": [], - "descriptionHTML": "

List issues in an organization assigned to the authenticated user.

\n

Note: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.

", + "descriptionHTML": "

List issues in an organization assigned to the authenticated user.

\n

Note: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -258659,7 +258778,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -261969,7 +262088,7 @@ } ], "previews": [], - "descriptionHTML": "

List issues in a repository. Only open issues will be listed.

\n

Note: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.

", + "descriptionHTML": "

List issues in a repository. Only open issues will be listed.

\n

Note: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.

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

The API returns a 301 Moved Permanently status if the issue was\ntransferred to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a 404 Not Found status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a 410 Gone status. To receive webhook events for transferred and deleted issues, subscribe\nto the issues webhook.

\n

Note: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.

", + "descriptionHTML": "

The API returns a 301 Moved Permanently status if the issue was\ntransferred to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a 404 Not Found status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a 410 Gone status. To receive webhook events for transferred and deleted issues, subscribe\nto the issues webhook.

\n

Note: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -272386,7 +272505,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -275794,7 +275913,7 @@ } ], "previews": [], - "descriptionHTML": "

List issues across owned and member repositories assigned to the authenticated user.

\n

Note: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.

", + "descriptionHTML": "

List issues across owned and member repositories assigned to the authenticated user.

\n

Note: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -282955,7 +283074,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -285288,7 +285407,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -357826,22 +357945,6 @@ "enum": [ "creation" ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" } } }, @@ -357859,22 +357962,6 @@ "update" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -357902,22 +357989,6 @@ "enum": [ "deletion" ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" } } }, @@ -357934,22 +358005,6 @@ "enum": [ "required_linear_history" ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" } } }, @@ -357967,22 +358022,6 @@ "required_deployments" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -358013,22 +358052,6 @@ "enum": [ "required_signatures" ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" } } }, @@ -358046,22 +358069,6 @@ "pull_request" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -358112,22 +358119,6 @@ "required_status_checks" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -358178,22 +358169,6 @@ "enum": [ "non_fast_forward" ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" } } }, @@ -358211,22 +358186,6 @@ "commit_message_pattern" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -358274,22 +358233,6 @@ "commit_author_email_pattern" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -358337,22 +358280,6 @@ "committer_email_pattern" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -358400,22 +358327,6 @@ "branch_name_pattern" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -358463,22 +358374,6 @@ "tag_name_pattern" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -358751,25 +358646,6 @@ "enum": [ "creation" ] - }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" } ] }, @@ -358790,25 +358666,6 @@ "update" ] }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" - }, { "type": "object", "name": "parameters", @@ -358840,25 +358697,6 @@ "enum": [ "deletion" ] - }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" } ] }, @@ -358878,25 +358716,6 @@ "enum": [ "required_linear_history" ] - }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" } ] }, @@ -358917,25 +358736,6 @@ "required_deployments" ] }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" - }, { "type": "object", "name": "parameters", @@ -358967,25 +358767,6 @@ "enum": [ "required_signatures" ] - }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" } ] }, @@ -359006,25 +358787,6 @@ "pull_request" ] }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" - }, { "type": "object", "name": "parameters", @@ -359081,25 +358843,6 @@ "required_status_checks" ] }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" - }, { "type": "object", "name": "parameters", @@ -359150,25 +358893,6 @@ "enum": [ "non_fast_forward" ] - }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" } ] }, @@ -359189,25 +358913,6 @@ "commit_message_pattern" ] }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" - }, { "type": "object", "name": "parameters", @@ -359262,25 +358967,6 @@ "commit_author_email_pattern" ] }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" - }, { "type": "object", "name": "parameters", @@ -359335,25 +359021,6 @@ "committer_email_pattern" ] }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" - }, { "type": "object", "name": "parameters", @@ -359408,25 +359075,6 @@ "branch_name_pattern" ] }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" - }, { "type": "object", "name": "parameters", @@ -359481,25 +359129,6 @@ "tag_name_pattern" ] }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" - }, { "type": "object", "name": "parameters", @@ -359933,22 +359562,6 @@ "enum": [ "creation" ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" } } }, @@ -359966,22 +359579,6 @@ "update" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -360009,22 +359606,6 @@ "enum": [ "deletion" ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" } } }, @@ -360041,22 +359622,6 @@ "enum": [ "required_linear_history" ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" } } }, @@ -360074,22 +359639,6 @@ "required_deployments" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -360120,22 +359669,6 @@ "enum": [ "required_signatures" ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" } } }, @@ -360153,22 +359686,6 @@ "pull_request" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -360219,22 +359736,6 @@ "required_status_checks" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -360285,22 +359786,6 @@ "enum": [ "non_fast_forward" ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" } } }, @@ -360318,22 +359803,6 @@ "commit_message_pattern" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -360381,22 +359850,6 @@ "commit_author_email_pattern" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -360444,22 +359897,6 @@ "committer_email_pattern" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -360507,22 +359944,6 @@ "branch_name_pattern" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -360570,22 +359991,6 @@ "tag_name_pattern" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -361040,22 +360445,6 @@ "enum": [ "creation" ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" } } }, @@ -361073,22 +360462,6 @@ "update" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -361116,22 +360489,6 @@ "enum": [ "deletion" ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" } } }, @@ -361148,22 +360505,6 @@ "enum": [ "required_linear_history" ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" } } }, @@ -361181,22 +360522,6 @@ "required_deployments" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -361227,22 +360552,6 @@ "enum": [ "required_signatures" ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" } } }, @@ -361260,22 +360569,6 @@ "pull_request" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -361326,22 +360619,6 @@ "required_status_checks" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -361392,22 +360669,6 @@ "enum": [ "non_fast_forward" ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" } } }, @@ -361425,22 +360686,6 @@ "commit_message_pattern" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -361488,22 +360733,6 @@ "commit_author_email_pattern" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -361551,22 +360780,6 @@ "committer_email_pattern" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -361614,22 +360827,6 @@ "branch_name_pattern" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -361677,22 +360874,6 @@ "tag_name_pattern" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -361971,25 +361152,6 @@ "enum": [ "creation" ] - }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" } ] }, @@ -362010,25 +361172,6 @@ "update" ] }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" - }, { "type": "object", "name": "parameters", @@ -362060,25 +361203,6 @@ "enum": [ "deletion" ] - }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" } ] }, @@ -362098,25 +361222,6 @@ "enum": [ "required_linear_history" ] - }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" } ] }, @@ -362137,25 +361242,6 @@ "required_deployments" ] }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" - }, { "type": "object", "name": "parameters", @@ -362187,25 +361273,6 @@ "enum": [ "required_signatures" ] - }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" } ] }, @@ -362226,25 +361293,6 @@ "pull_request" ] }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" - }, { "type": "object", "name": "parameters", @@ -362301,25 +361349,6 @@ "required_status_checks" ] }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" - }, { "type": "object", "name": "parameters", @@ -362370,25 +361399,6 @@ "enum": [ "non_fast_forward" ] - }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" } ] }, @@ -362409,25 +361419,6 @@ "commit_message_pattern" ] }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" - }, { "type": "object", "name": "parameters", @@ -362482,25 +361473,6 @@ "commit_author_email_pattern" ] }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" - }, { "type": "object", "name": "parameters", @@ -362555,25 +361527,6 @@ "committer_email_pattern" ] }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" - }, { "type": "object", "name": "parameters", @@ -362628,25 +361581,6 @@ "branch_name_pattern" ] }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" - }, { "type": "object", "name": "parameters", @@ -362701,25 +361635,6 @@ "tag_name_pattern" ] }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" - }, { "type": "object", "name": "parameters", @@ -363154,22 +362069,6 @@ "enum": [ "creation" ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" } } }, @@ -363187,22 +362086,6 @@ "update" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -363230,22 +362113,6 @@ "enum": [ "deletion" ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" } } }, @@ -363262,22 +362129,6 @@ "enum": [ "required_linear_history" ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" } } }, @@ -363295,22 +362146,6 @@ "required_deployments" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -363341,22 +362176,6 @@ "enum": [ "required_signatures" ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" } } }, @@ -363374,22 +362193,6 @@ "pull_request" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -363440,22 +362243,6 @@ "required_status_checks" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -363506,22 +362293,6 @@ "enum": [ "non_fast_forward" ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" } } }, @@ -363539,22 +362310,6 @@ "commit_message_pattern" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -363602,22 +362357,6 @@ "commit_author_email_pattern" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -363665,22 +362404,6 @@ "committer_email_pattern" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -363728,22 +362451,6 @@ "branch_name_pattern" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -363791,22 +362498,6 @@ "tag_name_pattern" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -407183,7 +405874,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -409196,7 +407887,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -424049,7 +422740,7 @@ } ], "previews": [], - "descriptionHTML": "

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.

\n

Pull request reviews created in the PENDING state are not submitted and therefore do not include the submitted_at property in the response. To create a pending review for a pull request, leave the event parameter blank. For more information about submitting a PENDING review, see \"Submit a review for a pull request.\"

\n

Note: To comment on a specific line in a file, you need to first determine the position of that line in the diff. The GitHub REST API offers the application/vnd.github.v3.diff media type. To see a pull request diff, add this media type to the Accept header of a call to the single pull request endpoint.

\n

The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.

", + "descriptionHTML": "

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.

\n

Pull request reviews created in the PENDING state are not submitted and therefore do not include the submitted_at property in the response. To create a pending review for a pull request, leave the event parameter blank. For more information about submitting a PENDING review, see \"Submit a review for a pull request.\"

\n

Note: To comment on a specific line in a file, you need to first determine the position of that line in the diff. The GitHub REST API offers the application/vnd.github.v3.diff media type. To see a pull request diff, add this media type to the Accept header of a call to the single pull request endpoint.

\n

The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.

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

Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion comment endpoint.

\n

List the reactions to a team discussion comment. OAuth access tokens require the read:discussion scope.

", + "descriptionHTML": "

Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion comment endpoint.

\n

List the reactions to a team discussion comment. OAuth access tokens require the read:discussion scope.

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

Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"Create reaction for a team discussion comment\" endpoint.

\n

Create a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.

", + "descriptionHTML": "

Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"Create reaction for a team discussion comment\" endpoint.

\n

Create a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.

", "statusCodes": [ { "httpStatusCode": "201", @@ -435505,7 +434196,7 @@ } ], "previews": [], - "descriptionHTML": "

Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion endpoint.

\n

List the reactions to a team discussion. OAuth access tokens require the read:discussion scope.

", + "descriptionHTML": "

Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion endpoint.

\n

List the reactions to a team discussion. OAuth access tokens require the read:discussion scope.

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

Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create reaction for a team discussion endpoint.

\n

Create a reaction to a team discussion. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion.

", + "descriptionHTML": "

Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create reaction for a team discussion endpoint.

\n

Create a reaction to a team discussion. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion.

", "statusCodes": [ { "httpStatusCode": "201", @@ -479085,706 +477776,846 @@ "items": { "title": "Repository Rule", "type": "object", - "description": "A repository rule.", + "description": "A repository rule with ruleset details.", "oneOf": [ { - "title": "creation", - "description": "Only allow users with bypass permission to create matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "creation" - ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - } - } - }, - { - "title": "update", - "description": "Only allow users with bypass permission to update matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "update" - ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, - "parameters": { + "allOf": [ + { + "title": "creation", + "description": "Only allow users with bypass permission to create matching refs.", "type": "object", - "properties": { - "update_allows_fetch_and_merge": { - "type": "boolean", - "description": "Branch can pull changes from its upstream repository" - } - }, "required": [ - "update_allows_fetch_and_merge" - ] - } - } - }, - { - "title": "deletion", - "description": "Only allow users with bypass permissions to delete matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "deletion" - ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - } - } - }, - { - "title": "required_linear_history", - "description": "Prevent merge commits from being pushed to matching branches.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_linear_history" - ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - } - } - }, - { - "title": "required_deployments", - "description": "Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_deployments" - ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, - "parameters": { - "type": "object", + "type" + ], "properties": { - "required_deployment_environments": { - "type": "array", - "description": "The environments that must be successfully deployed to before branches can be merged.", - "items": { - "type": "string" - } + "type": { + "type": "string", + "enum": [ + "creation" + ] } - }, - "required": [ - "required_deployment_environments" - ] - } - } - }, - { - "title": "required_signatures", - "description": "Commits pushed to matching branches must have verified signatures.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_signatures" - ] + } }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - } - } - }, - { - "title": "pull_request", - "description": "Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "pull_request" - ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, - "parameters": { - "type": "object", + { + "title": "repository ruleset data for rule", + "description": "User-defined metadata to store domain-specific information limited to 8 keys with scalar values.", "properties": { - "dismiss_stale_reviews_on_push": { - "type": "boolean", - "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." + "ruleset_source_type": { + "type": "string", + "description": "The type of source for the ruleset that includes this rule.", + "enum": [ + "Repository", + "Organization" + ] }, - "require_code_owner_review": { - "type": "boolean", - "description": "Require an approving review in pull requests that modify files that have a designated code owner." + "ruleset_source": { + "type": "string", + "description": "The name of the source of the ruleset that includes this rule." }, - "require_last_push_approval": { - "type": "boolean", - "description": "Whether the most recent reviewable push must be approved by someone other than the person who pushed it." - }, - "required_approving_review_count": { + "ruleset_id": { "type": "integer", - "description": "The number of approving reviews that are required before a pull request can be merged.", - "minimum": 0, - "maximum": 10 - }, - "required_review_thread_resolution": { - "type": "boolean", - "description": "All conversations on code must be resolved before a pull request can be merged." + "description": "The ID of the ruleset that includes this rule." } - }, - "required": [ - "dismiss_stale_reviews_on_push", - "require_code_owner_review", - "require_last_push_approval", - "required_approving_review_count", - "required_review_thread_resolution" - ] + } } - } + ] }, { - "title": "required_status_checks", - "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_status_checks" - ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, - "parameters": { + "allOf": [ + { + "title": "update", + "description": "Only allow users with bypass permission to update matching refs.", "type": "object", + "required": [ + "type" + ], "properties": { - "required_status_checks": { - "type": "array", - "description": "Status checks that are required.", - "items": { - "title": "StatusCheckConfiguration", - "description": "Required status check", - "type": "object", - "properties": { - "context": { - "type": "string", - "description": "The status check context name that must be present on the commit." - }, - "integration_id": { - "type": "integer", - "description": "The optional integration ID that this status check must originate from." + "type": { + "type": "string", + "enum": [ + "update" + ] + }, + "parameters": { + "type": "object", + "properties": { + "update_allows_fetch_and_merge": { + "type": "boolean", + "description": "Branch can pull changes from its upstream repository" + } + }, + "required": [ + "update_allows_fetch_and_merge" + ] + } + } + }, + { + "title": "repository ruleset data for rule", + "description": "User-defined metadata to store domain-specific information limited to 8 keys with scalar values.", + "properties": { + "ruleset_source_type": { + "type": "string", + "description": "The type of source for the ruleset that includes this rule.", + "enum": [ + "Repository", + "Organization" + ] + }, + "ruleset_source": { + "type": "string", + "description": "The name of the source of the ruleset that includes this rule." + }, + "ruleset_id": { + "type": "integer", + "description": "The ID of the ruleset that includes this rule." + } + } + } + ] + }, + { + "allOf": [ + { + "title": "deletion", + "description": "Only allow users with bypass permissions to delete matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "deletion" + ] + } + } + }, + { + "title": "repository ruleset data for rule", + "description": "User-defined metadata to store domain-specific information limited to 8 keys with scalar values.", + "properties": { + "ruleset_source_type": { + "type": "string", + "description": "The type of source for the ruleset that includes this rule.", + "enum": [ + "Repository", + "Organization" + ] + }, + "ruleset_source": { + "type": "string", + "description": "The name of the source of the ruleset that includes this rule." + }, + "ruleset_id": { + "type": "integer", + "description": "The ID of the ruleset that includes this rule." + } + } + } + ] + }, + { + "allOf": [ + { + "title": "required_linear_history", + "description": "Prevent merge commits from being pushed to matching branches.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_linear_history" + ] + } + } + }, + { + "title": "repository ruleset data for rule", + "description": "User-defined metadata to store domain-specific information limited to 8 keys with scalar values.", + "properties": { + "ruleset_source_type": { + "type": "string", + "description": "The type of source for the ruleset that includes this rule.", + "enum": [ + "Repository", + "Organization" + ] + }, + "ruleset_source": { + "type": "string", + "description": "The name of the source of the ruleset that includes this rule." + }, + "ruleset_id": { + "type": "integer", + "description": "The ID of the ruleset that includes this rule." + } + } + } + ] + }, + { + "allOf": [ + { + "title": "required_deployments", + "description": "Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_deployments" + ] + }, + "parameters": { + "type": "object", + "properties": { + "required_deployment_environments": { + "type": "array", + "description": "The environments that must be successfully deployed to before branches can be merged.", + "items": { + "type": "string" + } + } + }, + "required": [ + "required_deployment_environments" + ] + } + } + }, + { + "title": "repository ruleset data for rule", + "description": "User-defined metadata to store domain-specific information limited to 8 keys with scalar values.", + "properties": { + "ruleset_source_type": { + "type": "string", + "description": "The type of source for the ruleset that includes this rule.", + "enum": [ + "Repository", + "Organization" + ] + }, + "ruleset_source": { + "type": "string", + "description": "The name of the source of the ruleset that includes this rule." + }, + "ruleset_id": { + "type": "integer", + "description": "The ID of the ruleset that includes this rule." + } + } + } + ] + }, + { + "allOf": [ + { + "title": "required_signatures", + "description": "Commits pushed to matching branches must have verified signatures.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_signatures" + ] + } + } + }, + { + "title": "repository ruleset data for rule", + "description": "User-defined metadata to store domain-specific information limited to 8 keys with scalar values.", + "properties": { + "ruleset_source_type": { + "type": "string", + "description": "The type of source for the ruleset that includes this rule.", + "enum": [ + "Repository", + "Organization" + ] + }, + "ruleset_source": { + "type": "string", + "description": "The name of the source of the ruleset that includes this rule." + }, + "ruleset_id": { + "type": "integer", + "description": "The ID of the ruleset that includes this rule." + } + } + } + ] + }, + { + "allOf": [ + { + "title": "pull_request", + "description": "Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "pull_request" + ] + }, + "parameters": { + "type": "object", + "properties": { + "dismiss_stale_reviews_on_push": { + "type": "boolean", + "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." + }, + "require_code_owner_review": { + "type": "boolean", + "description": "Require an approving review in pull requests that modify files that have a designated code owner." + }, + "require_last_push_approval": { + "type": "boolean", + "description": "Whether the most recent reviewable push must be approved by someone other than the person who pushed it." + }, + "required_approving_review_count": { + "type": "integer", + "description": "The number of approving reviews that are required before a pull request can be merged.", + "minimum": 0, + "maximum": 10 + }, + "required_review_thread_resolution": { + "type": "boolean", + "description": "All conversations on code must be resolved before a pull request can be merged." + } + }, + "required": [ + "dismiss_stale_reviews_on_push", + "require_code_owner_review", + "require_last_push_approval", + "required_approving_review_count", + "required_review_thread_resolution" + ] + } + } + }, + { + "title": "repository ruleset data for rule", + "description": "User-defined metadata to store domain-specific information limited to 8 keys with scalar values.", + "properties": { + "ruleset_source_type": { + "type": "string", + "description": "The type of source for the ruleset that includes this rule.", + "enum": [ + "Repository", + "Organization" + ] + }, + "ruleset_source": { + "type": "string", + "description": "The name of the source of the ruleset that includes this rule." + }, + "ruleset_id": { + "type": "integer", + "description": "The ID of the ruleset that includes this rule." + } + } + } + ] + }, + { + "allOf": [ + { + "title": "required_status_checks", + "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_status_checks" + ] + }, + "parameters": { + "type": "object", + "properties": { + "required_status_checks": { + "type": "array", + "description": "Status checks that are required.", + "items": { + "title": "StatusCheckConfiguration", + "description": "Required status check", + "type": "object", + "properties": { + "context": { + "type": "string", + "description": "The status check context name that must be present on the commit." + }, + "integration_id": { + "type": "integer", + "description": "The optional integration ID that this status check must originate from." + } + }, + "required": [ + "context" + ] } }, - "required": [ - "context" - ] - } - }, - "strict_required_status_checks_policy": { - "type": "boolean", - "description": "Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled." + "strict_required_status_checks_policy": { + "type": "boolean", + "description": "Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled." + } + }, + "required": [ + "required_status_checks", + "strict_required_status_checks_policy" + ] } - }, - "required": [ - "required_status_checks", - "strict_required_status_checks_policy" - ] - } - } - }, - { - "title": "non_fast_forward", - "description": "Prevent users with push access from force pushing to branches.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "non_fast_forward" - ] + } }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - } - } - }, - { - "title": "commit_message_pattern", - "description": "Parameters to be used for the commit_message_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "commit_message_pattern" - ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, - "parameters": { - "type": "object", + { + "title": "repository ruleset data for rule", + "description": "User-defined metadata to store domain-specific information limited to 8 keys with scalar values.", "properties": { - "name": { + "ruleset_source_type": { "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", + "description": "The type of source for the ruleset that includes this rule.", "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" + "Repository", + "Organization" ] }, - "pattern": { + "ruleset_source": { "type": "string", - "description": "The pattern to match with." + "description": "The name of the source of the ruleset that includes this rule." + }, + "ruleset_id": { + "type": "integer", + "description": "The ID of the ruleset that includes this rule." } - }, - "required": [ - "operator", - "pattern" - ] + } } - } + ] }, { - "title": "commit_author_email_pattern", - "description": "Parameters to be used for the commit_author_email_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "commit_author_email_pattern" - ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, - "parameters": { + "allOf": [ + { + "title": "non_fast_forward", + "description": "Prevent users with push access from force pushing to branches.", "type": "object", + "required": [ + "type" + ], "properties": { - "name": { + "type": { "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" + "non_fast_forward" + ] + } + } + }, + { + "title": "repository ruleset data for rule", + "description": "User-defined metadata to store domain-specific information limited to 8 keys with scalar values.", + "properties": { + "ruleset_source_type": { + "type": "string", + "description": "The type of source for the ruleset that includes this rule.", + "enum": [ + "Repository", + "Organization" ] }, - "pattern": { + "ruleset_source": { "type": "string", - "description": "The pattern to match with." + "description": "The name of the source of the ruleset that includes this rule." + }, + "ruleset_id": { + "type": "integer", + "description": "The ID of the ruleset that includes this rule." } - }, - "required": [ - "operator", - "pattern" - ] + } } - } + ] }, { - "title": "committer_email_pattern", - "description": "Parameters to be used for the committer_email_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "committer_email_pattern" - ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, - "parameters": { + "allOf": [ + { + "title": "commit_message_pattern", + "description": "Parameters to be used for the commit_message_pattern rule", "type": "object", + "required": [ + "type" + ], "properties": { - "name": { + "type": { "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" + "commit_message_pattern" ] }, - "pattern": { - "type": "string", - "description": "The pattern to match with." + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] } - }, - "required": [ - "operator", - "pattern" - ] + } + }, + { + "title": "repository ruleset data for rule", + "description": "User-defined metadata to store domain-specific information limited to 8 keys with scalar values.", + "properties": { + "ruleset_source_type": { + "type": "string", + "description": "The type of source for the ruleset that includes this rule.", + "enum": [ + "Repository", + "Organization" + ] + }, + "ruleset_source": { + "type": "string", + "description": "The name of the source of the ruleset that includes this rule." + }, + "ruleset_id": { + "type": "integer", + "description": "The ID of the ruleset that includes this rule." + } + } } - } + ] }, { - "title": "branch_name_pattern", - "description": "Parameters to be used for the branch_name_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "branch_name_pattern" - ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, - "parameters": { + "allOf": [ + { + "title": "commit_author_email_pattern", + "description": "Parameters to be used for the commit_author_email_pattern rule", "type": "object", + "required": [ + "type" + ], "properties": { - "name": { + "type": { "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" + "commit_author_email_pattern" ] }, - "pattern": { - "type": "string", - "description": "The pattern to match with." + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] } - }, - "required": [ - "operator", - "pattern" - ] + } + }, + { + "title": "repository ruleset data for rule", + "description": "User-defined metadata to store domain-specific information limited to 8 keys with scalar values.", + "properties": { + "ruleset_source_type": { + "type": "string", + "description": "The type of source for the ruleset that includes this rule.", + "enum": [ + "Repository", + "Organization" + ] + }, + "ruleset_source": { + "type": "string", + "description": "The name of the source of the ruleset that includes this rule." + }, + "ruleset_id": { + "type": "integer", + "description": "The ID of the ruleset that includes this rule." + } + } } - } + ] }, { - "title": "tag_name_pattern", - "description": "Parameters to be used for the tag_name_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "tag_name_pattern" - ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, - "parameters": { + "allOf": [ + { + "title": "committer_email_pattern", + "description": "Parameters to be used for the committer_email_pattern rule", "type": "object", + "required": [ + "type" + ], "properties": { - "name": { + "type": { "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" + "committer_email_pattern" ] }, - "pattern": { - "type": "string", - "description": "The pattern to match with." + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] } - }, - "required": [ - "operator", - "pattern" - ] + } + }, + { + "title": "repository ruleset data for rule", + "description": "User-defined metadata to store domain-specific information limited to 8 keys with scalar values.", + "properties": { + "ruleset_source_type": { + "type": "string", + "description": "The type of source for the ruleset that includes this rule.", + "enum": [ + "Repository", + "Organization" + ] + }, + "ruleset_source": { + "type": "string", + "description": "The name of the source of the ruleset that includes this rule." + }, + "ruleset_id": { + "type": "integer", + "description": "The ID of the ruleset that includes this rule." + } + } } - } + ] + }, + { + "allOf": [ + { + "title": "branch_name_pattern", + "description": "Parameters to be used for the branch_name_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "branch_name_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "repository ruleset data for rule", + "description": "User-defined metadata to store domain-specific information limited to 8 keys with scalar values.", + "properties": { + "ruleset_source_type": { + "type": "string", + "description": "The type of source for the ruleset that includes this rule.", + "enum": [ + "Repository", + "Organization" + ] + }, + "ruleset_source": { + "type": "string", + "description": "The name of the source of the ruleset that includes this rule." + }, + "ruleset_id": { + "type": "integer", + "description": "The ID of the ruleset that includes this rule." + } + } + } + ] + }, + { + "allOf": [ + { + "title": "tag_name_pattern", + "description": "Parameters to be used for the tag_name_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "tag_name_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "repository ruleset data for rule", + "description": "User-defined metadata to store domain-specific information limited to 8 keys with scalar values.", + "properties": { + "ruleset_source_type": { + "type": "string", + "description": "The type of source for the ruleset that includes this rule.", + "enum": [ + "Repository", + "Organization" + ] + }, + "ruleset_source": { + "type": "string", + "description": "The name of the source of the ruleset that includes this rule." + }, + "ruleset_id": { + "type": "integer", + "description": "The ID of the ruleset that includes this rule." + } + } + } + ] } ] } @@ -480201,22 +479032,6 @@ "enum": [ "creation" ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" } } }, @@ -480234,22 +479049,6 @@ "update" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -480277,22 +479076,6 @@ "enum": [ "deletion" ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" } } }, @@ -480309,22 +479092,6 @@ "enum": [ "required_linear_history" ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" } } }, @@ -480342,22 +479109,6 @@ "required_deployments" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -480388,22 +479139,6 @@ "enum": [ "required_signatures" ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" } } }, @@ -480421,22 +479156,6 @@ "pull_request" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -480487,22 +479206,6 @@ "required_status_checks" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -480553,22 +479256,6 @@ "enum": [ "non_fast_forward" ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" } } }, @@ -480586,22 +479273,6 @@ "commit_message_pattern" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -480649,22 +479320,6 @@ "commit_author_email_pattern" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -480712,22 +479367,6 @@ "committer_email_pattern" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -480775,22 +479414,6 @@ "branch_name_pattern" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -480838,22 +479461,6 @@ "tag_name_pattern" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -481061,25 +479668,6 @@ "enum": [ "creation" ] - }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" } ] }, @@ -481100,25 +479688,6 @@ "update" ] }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" - }, { "type": "object", "name": "parameters", @@ -481150,25 +479719,6 @@ "enum": [ "deletion" ] - }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" } ] }, @@ -481188,25 +479738,6 @@ "enum": [ "required_linear_history" ] - }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" } ] }, @@ -481227,25 +479758,6 @@ "required_deployments" ] }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" - }, { "type": "object", "name": "parameters", @@ -481277,25 +479789,6 @@ "enum": [ "required_signatures" ] - }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" } ] }, @@ -481316,25 +479809,6 @@ "pull_request" ] }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" - }, { "type": "object", "name": "parameters", @@ -481391,25 +479865,6 @@ "required_status_checks" ] }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" - }, { "type": "object", "name": "parameters", @@ -481460,25 +479915,6 @@ "enum": [ "non_fast_forward" ] - }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" } ] }, @@ -481499,25 +479935,6 @@ "commit_message_pattern" ] }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" - }, { "type": "object", "name": "parameters", @@ -481572,25 +479989,6 @@ "commit_author_email_pattern" ] }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" - }, { "type": "object", "name": "parameters", @@ -481645,25 +480043,6 @@ "committer_email_pattern" ] }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" - }, { "type": "object", "name": "parameters", @@ -481718,25 +480097,6 @@ "branch_name_pattern" ] }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" - }, { "type": "object", "name": "parameters", @@ -481791,25 +480151,6 @@ "tag_name_pattern" ] }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" - }, { "type": "object", "name": "parameters", @@ -482234,22 +480575,6 @@ "enum": [ "creation" ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" } } }, @@ -482267,22 +480592,6 @@ "update" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -482310,22 +480619,6 @@ "enum": [ "deletion" ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" } } }, @@ -482342,22 +480635,6 @@ "enum": [ "required_linear_history" ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" } } }, @@ -482375,22 +480652,6 @@ "required_deployments" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -482421,22 +480682,6 @@ "enum": [ "required_signatures" ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" } } }, @@ -482454,22 +480699,6 @@ "pull_request" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -482520,22 +480749,6 @@ "required_status_checks" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -482586,22 +480799,6 @@ "enum": [ "non_fast_forward" ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" } } }, @@ -482619,22 +480816,6 @@ "commit_message_pattern" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -482682,22 +480863,6 @@ "commit_author_email_pattern" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -482745,22 +480910,6 @@ "committer_email_pattern" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -482808,22 +480957,6 @@ "branch_name_pattern" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -482871,22 +481004,6 @@ "tag_name_pattern" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -483351,22 +481468,6 @@ "enum": [ "creation" ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" } } }, @@ -483384,22 +481485,6 @@ "update" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -483427,22 +481512,6 @@ "enum": [ "deletion" ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" } } }, @@ -483459,22 +481528,6 @@ "enum": [ "required_linear_history" ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" } } }, @@ -483492,22 +481545,6 @@ "required_deployments" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -483538,22 +481575,6 @@ "enum": [ "required_signatures" ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" } } }, @@ -483571,22 +481592,6 @@ "pull_request" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -483637,22 +481642,6 @@ "required_status_checks" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -483703,22 +481692,6 @@ "enum": [ "non_fast_forward" ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" } } }, @@ -483736,22 +481709,6 @@ "commit_message_pattern" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -483799,22 +481756,6 @@ "commit_author_email_pattern" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -483862,22 +481803,6 @@ "committer_email_pattern" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -483925,22 +481850,6 @@ "branch_name_pattern" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -483988,22 +481897,6 @@ "tag_name_pattern" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -484217,25 +482110,6 @@ "enum": [ "creation" ] - }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" } ] }, @@ -484256,25 +482130,6 @@ "update" ] }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" - }, { "type": "object", "name": "parameters", @@ -484306,25 +482161,6 @@ "enum": [ "deletion" ] - }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" } ] }, @@ -484344,25 +482180,6 @@ "enum": [ "required_linear_history" ] - }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" } ] }, @@ -484383,25 +482200,6 @@ "required_deployments" ] }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" - }, { "type": "object", "name": "parameters", @@ -484433,25 +482231,6 @@ "enum": [ "required_signatures" ] - }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" } ] }, @@ -484472,25 +482251,6 @@ "pull_request" ] }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" - }, { "type": "object", "name": "parameters", @@ -484547,25 +482307,6 @@ "required_status_checks" ] }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" - }, { "type": "object", "name": "parameters", @@ -484616,25 +482357,6 @@ "enum": [ "non_fast_forward" ] - }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" } ] }, @@ -484655,25 +482377,6 @@ "commit_message_pattern" ] }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" - }, { "type": "object", "name": "parameters", @@ -484728,25 +482431,6 @@ "commit_author_email_pattern" ] }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" - }, { "type": "object", "name": "parameters", @@ -484801,25 +482485,6 @@ "committer_email_pattern" ] }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" - }, { "type": "object", "name": "parameters", @@ -484874,25 +482539,6 @@ "branch_name_pattern" ] }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" - }, { "type": "object", "name": "parameters", @@ -484947,25 +482593,6 @@ "tag_name_pattern" ] }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" - }, { "type": "object", "name": "parameters", @@ -485391,22 +483018,6 @@ "enum": [ "creation" ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" } } }, @@ -485424,22 +483035,6 @@ "update" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -485467,22 +483062,6 @@ "enum": [ "deletion" ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" } } }, @@ -485499,22 +483078,6 @@ "enum": [ "required_linear_history" ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" } } }, @@ -485532,22 +483095,6 @@ "required_deployments" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -485578,22 +483125,6 @@ "enum": [ "required_signatures" ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" } } }, @@ -485611,22 +483142,6 @@ "pull_request" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -485677,22 +483192,6 @@ "required_status_checks" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -485743,22 +483242,6 @@ "enum": [ "non_fast_forward" ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" } } }, @@ -485776,22 +483259,6 @@ "commit_message_pattern" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -485839,22 +483306,6 @@ "commit_author_email_pattern" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -485902,22 +483353,6 @@ "committer_email_pattern" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -485965,22 +483400,6 @@ "branch_name_pattern" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -486028,22 +483447,6 @@ "tag_name_pattern" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -500155,6 +497558,558 @@ "additionalProperties": false }, "readOnly": true + }, + "private_fork": { + "readOnly": true, + "description": "A temporary private fork of the advisory's repository for collaborating on a fix.", + "allOf": [ + { + "title": "Simple Repository", + "description": "A GitHub repository.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "A unique identifier of the repository.", + "examples": [ + 1296269 + ] + }, + "node_id": { + "type": "string", + "description": "The GraphQL identifier of the repository.", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "type": "string", + "description": "The name of the repository.", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "description": "The full, globally unique, name of the repository.", + "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", + "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\"" + ] + } + }, + "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", + "description": "Whether the repository is private." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL to view the repository on GitHub.com.", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The repository description.", + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean", + "description": "Whether the repository is a fork." + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL to get more information about the repository from the GitHub API.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "description": "A template for the API URL to download the repository as an archive.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "description": "A template for the API URL to list the available assignees for issues in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git blob in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "description": "A template for the API URL to get information about branches in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "description": "A template for the API URL to get information about collaborators of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "description": "A template for the API URL to get information about comments on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "description": "A template for the API URL to get information about commits on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "description": "A template for the API URL to compare two commits or refs.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "description": "A template for the API URL to get the contents of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "description": "A template for the API URL to list the contributors to the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the deployments of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the downloads on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the events of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the forks of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "description": "A template for the API URL to get information about Git commits of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "description": "A template for the API URL to get information about Git refs of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "description": "A template for the API URL to get information about Git tags of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "issue_comment_url": { + "type": "string", + "description": "A template for the API URL to get information about issue comments on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "description": "A template for the API URL to get information about issue events on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "description": "A template for the API URL to get information about issues on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "description": "A template for the API URL to get information about deploy keys on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "description": "A template for the API URL to get information about labels of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about the languages of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "description": "The API URL to merge branches in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "description": "A template for the API URL to get information about milestones of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "description": "A template for the API URL to get information about notifications on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "description": "A template for the API URL to get information about pull requests on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "description": "A template for the API URL to get information about releases on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the stargazers on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "description": "A template for the API URL to get information about statuses of a commit.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the subscribers on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "description": "The API URL to subscribe to notifications for this repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about tags on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the teams on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git tree of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the hooks on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/hooks" + ] + } + }, + "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" + ] + } + ], + "type": [ + "null" + ] } }, "required": [ @@ -500180,7 +498135,8 @@ "cwes", "cwe_ids", "credits", - "credits_detailed" + "credits_detailed", + "private_fork" ], "additionalProperties": false } @@ -501426,6 +499382,558 @@ "additionalProperties": false }, "readOnly": true + }, + "private_fork": { + "readOnly": true, + "description": "A temporary private fork of the advisory's repository for collaborating on a fix.", + "allOf": [ + { + "title": "Simple Repository", + "description": "A GitHub repository.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "A unique identifier of the repository.", + "examples": [ + 1296269 + ] + }, + "node_id": { + "type": "string", + "description": "The GraphQL identifier of the repository.", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "type": "string", + "description": "The name of the repository.", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "description": "The full, globally unique, name of the repository.", + "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", + "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\"" + ] + } + }, + "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", + "description": "Whether the repository is private." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL to view the repository on GitHub.com.", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The repository description.", + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean", + "description": "Whether the repository is a fork." + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL to get more information about the repository from the GitHub API.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "description": "A template for the API URL to download the repository as an archive.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "description": "A template for the API URL to list the available assignees for issues in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git blob in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "description": "A template for the API URL to get information about branches in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "description": "A template for the API URL to get information about collaborators of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "description": "A template for the API URL to get information about comments on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "description": "A template for the API URL to get information about commits on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "description": "A template for the API URL to compare two commits or refs.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "description": "A template for the API URL to get the contents of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "description": "A template for the API URL to list the contributors to the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the deployments of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the downloads on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the events of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the forks of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "description": "A template for the API URL to get information about Git commits of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "description": "A template for the API URL to get information about Git refs of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "description": "A template for the API URL to get information about Git tags of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "issue_comment_url": { + "type": "string", + "description": "A template for the API URL to get information about issue comments on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "description": "A template for the API URL to get information about issue events on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "description": "A template for the API URL to get information about issues on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "description": "A template for the API URL to get information about deploy keys on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "description": "A template for the API URL to get information about labels of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about the languages of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "description": "The API URL to merge branches in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "description": "A template for the API URL to get information about milestones of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "description": "A template for the API URL to get information about notifications on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "description": "A template for the API URL to get information about pull requests on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "description": "A template for the API URL to get information about releases on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the stargazers on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "description": "A template for the API URL to get information about statuses of a commit.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the subscribers on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "description": "The API URL to subscribe to notifications for this repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about tags on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the teams on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git tree of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the hooks on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/hooks" + ] + } + }, + "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" + ] + } + ], + "type": [ + "null" + ] } }, "required": [ @@ -501451,7 +499959,8 @@ "cwes", "cwe_ids", "credits", - "credits_detailed" + "credits_detailed", + "private_fork" ], "additionalProperties": false } @@ -502618,6 +501127,558 @@ "additionalProperties": false }, "readOnly": true + }, + "private_fork": { + "readOnly": true, + "description": "A temporary private fork of the advisory's repository for collaborating on a fix.", + "allOf": [ + { + "title": "Simple Repository", + "description": "A GitHub repository.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "A unique identifier of the repository.", + "examples": [ + 1296269 + ] + }, + "node_id": { + "type": "string", + "description": "The GraphQL identifier of the repository.", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "type": "string", + "description": "The name of the repository.", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "description": "The full, globally unique, name of the repository.", + "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", + "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\"" + ] + } + }, + "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", + "description": "Whether the repository is private." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL to view the repository on GitHub.com.", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The repository description.", + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean", + "description": "Whether the repository is a fork." + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL to get more information about the repository from the GitHub API.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "description": "A template for the API URL to download the repository as an archive.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "description": "A template for the API URL to list the available assignees for issues in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git blob in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "description": "A template for the API URL to get information about branches in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "description": "A template for the API URL to get information about collaborators of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "description": "A template for the API URL to get information about comments on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "description": "A template for the API URL to get information about commits on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "description": "A template for the API URL to compare two commits or refs.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "description": "A template for the API URL to get the contents of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "description": "A template for the API URL to list the contributors to the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the deployments of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the downloads on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the events of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the forks of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "description": "A template for the API URL to get information about Git commits of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "description": "A template for the API URL to get information about Git refs of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "description": "A template for the API URL to get information about Git tags of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "issue_comment_url": { + "type": "string", + "description": "A template for the API URL to get information about issue comments on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "description": "A template for the API URL to get information about issue events on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "description": "A template for the API URL to get information about issues on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "description": "A template for the API URL to get information about deploy keys on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "description": "A template for the API URL to get information about labels of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about the languages of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "description": "The API URL to merge branches in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "description": "A template for the API URL to get information about milestones of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "description": "A template for the API URL to get information about notifications on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "description": "A template for the API URL to get information about pull requests on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "description": "A template for the API URL to get information about releases on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the stargazers on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "description": "A template for the API URL to get information about statuses of a commit.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the subscribers on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "description": "The API URL to subscribe to notifications for this repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about tags on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the teams on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git tree of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the hooks on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/hooks" + ] + } + }, + "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" + ] + } + ], + "type": [ + "null" + ] } }, "required": [ @@ -502643,7 +501704,8 @@ "cwes", "cwe_ids", "credits", - "credits_detailed" + "credits_detailed", + "private_fork" ], "additionalProperties": false } @@ -503732,6 +502794,558 @@ "additionalProperties": false }, "readOnly": true + }, + "private_fork": { + "readOnly": true, + "description": "A temporary private fork of the advisory's repository for collaborating on a fix.", + "allOf": [ + { + "title": "Simple Repository", + "description": "A GitHub repository.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "A unique identifier of the repository.", + "examples": [ + 1296269 + ] + }, + "node_id": { + "type": "string", + "description": "The GraphQL identifier of the repository.", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "type": "string", + "description": "The name of the repository.", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "description": "The full, globally unique, name of the repository.", + "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", + "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\"" + ] + } + }, + "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", + "description": "Whether the repository is private." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL to view the repository on GitHub.com.", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The repository description.", + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean", + "description": "Whether the repository is a fork." + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL to get more information about the repository from the GitHub API.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "description": "A template for the API URL to download the repository as an archive.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "description": "A template for the API URL to list the available assignees for issues in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git blob in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "description": "A template for the API URL to get information about branches in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "description": "A template for the API URL to get information about collaborators of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "description": "A template for the API URL to get information about comments on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "description": "A template for the API URL to get information about commits on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "description": "A template for the API URL to compare two commits or refs.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "description": "A template for the API URL to get the contents of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "description": "A template for the API URL to list the contributors to the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the deployments of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the downloads on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the events of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the forks of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "description": "A template for the API URL to get information about Git commits of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "description": "A template for the API URL to get information about Git refs of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "description": "A template for the API URL to get information about Git tags of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "issue_comment_url": { + "type": "string", + "description": "A template for the API URL to get information about issue comments on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "description": "A template for the API URL to get information about issue events on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "description": "A template for the API URL to get information about issues on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "description": "A template for the API URL to get information about deploy keys on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "description": "A template for the API URL to get information about labels of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about the languages of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "description": "The API URL to merge branches in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "description": "A template for the API URL to get information about milestones of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "description": "A template for the API URL to get information about notifications on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "description": "A template for the API URL to get information about pull requests on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "description": "A template for the API URL to get information about releases on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the stargazers on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "description": "A template for the API URL to get information about statuses of a commit.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the subscribers on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "description": "The API URL to subscribe to notifications for this repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about tags on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the teams on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git tree of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the hooks on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/hooks" + ] + } + }, + "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" + ] + } + ], + "type": [ + "null" + ] } }, "required": [ @@ -503757,7 +503371,8 @@ "cwes", "cwe_ids", "credits", - "credits_detailed" + "credits_detailed", + "private_fork" ], "additionalProperties": false } @@ -504991,6 +504606,558 @@ "additionalProperties": false }, "readOnly": true + }, + "private_fork": { + "readOnly": true, + "description": "A temporary private fork of the advisory's repository for collaborating on a fix.", + "allOf": [ + { + "title": "Simple Repository", + "description": "A GitHub repository.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "A unique identifier of the repository.", + "examples": [ + 1296269 + ] + }, + "node_id": { + "type": "string", + "description": "The GraphQL identifier of the repository.", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "type": "string", + "description": "The name of the repository.", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "description": "The full, globally unique, name of the repository.", + "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", + "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\"" + ] + } + }, + "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", + "description": "Whether the repository is private." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL to view the repository on GitHub.com.", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The repository description.", + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean", + "description": "Whether the repository is a fork." + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL to get more information about the repository from the GitHub API.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "description": "A template for the API URL to download the repository as an archive.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "description": "A template for the API URL to list the available assignees for issues in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git blob in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "description": "A template for the API URL to get information about branches in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "description": "A template for the API URL to get information about collaborators of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "description": "A template for the API URL to get information about comments on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "description": "A template for the API URL to get information about commits on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "description": "A template for the API URL to compare two commits or refs.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "description": "A template for the API URL to get the contents of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "description": "A template for the API URL to list the contributors to the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the deployments of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the downloads on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the events of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the forks of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "description": "A template for the API URL to get information about Git commits of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "description": "A template for the API URL to get information about Git refs of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "description": "A template for the API URL to get information about Git tags of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "issue_comment_url": { + "type": "string", + "description": "A template for the API URL to get information about issue comments on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "description": "A template for the API URL to get information about issue events on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "description": "A template for the API URL to get information about issues on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "description": "A template for the API URL to get information about deploy keys on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "description": "A template for the API URL to get information about labels of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about the languages of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "description": "The API URL to merge branches in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "description": "A template for the API URL to get information about milestones of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "description": "A template for the API URL to get information about notifications on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "description": "A template for the API URL to get information about pull requests on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "description": "A template for the API URL to get information about releases on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the stargazers on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "description": "A template for the API URL to get information about statuses of a commit.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the subscribers on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "description": "The API URL to subscribe to notifications for this repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about tags on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the teams on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git tree of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the hooks on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/hooks" + ] + } + }, + "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" + ] + } + ], + "type": [ + "null" + ] } }, "required": [ @@ -505016,7 +505183,8 @@ "cwes", "cwe_ids", "credits", - "credits_detailed" + "credits_detailed", + "private_fork" ], "additionalProperties": false } @@ -506053,6 +506221,558 @@ "additionalProperties": false }, "readOnly": true + }, + "private_fork": { + "readOnly": true, + "description": "A temporary private fork of the advisory's repository for collaborating on a fix.", + "allOf": [ + { + "title": "Simple Repository", + "description": "A GitHub repository.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "A unique identifier of the repository.", + "examples": [ + 1296269 + ] + }, + "node_id": { + "type": "string", + "description": "The GraphQL identifier of the repository.", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "type": "string", + "description": "The name of the repository.", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "description": "The full, globally unique, name of the repository.", + "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", + "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\"" + ] + } + }, + "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", + "description": "Whether the repository is private." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL to view the repository on GitHub.com.", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The repository description.", + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean", + "description": "Whether the repository is a fork." + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL to get more information about the repository from the GitHub API.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "description": "A template for the API URL to download the repository as an archive.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "description": "A template for the API URL to list the available assignees for issues in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git blob in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "description": "A template for the API URL to get information about branches in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "description": "A template for the API URL to get information about collaborators of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "description": "A template for the API URL to get information about comments on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "description": "A template for the API URL to get information about commits on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "description": "A template for the API URL to compare two commits or refs.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "description": "A template for the API URL to get the contents of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "description": "A template for the API URL to list the contributors to the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the deployments of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the downloads on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the events of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the forks of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "description": "A template for the API URL to get information about Git commits of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "description": "A template for the API URL to get information about Git refs of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "description": "A template for the API URL to get information about Git tags of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "issue_comment_url": { + "type": "string", + "description": "A template for the API URL to get information about issue comments on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "description": "A template for the API URL to get information about issue events on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "description": "A template for the API URL to get information about issues on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "description": "A template for the API URL to get information about deploy keys on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "description": "A template for the API URL to get information about labels of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about the languages of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "description": "The API URL to merge branches in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "description": "A template for the API URL to get information about milestones of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "description": "A template for the API URL to get information about notifications on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "description": "A template for the API URL to get information about pull requests on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "description": "A template for the API URL to get information about releases on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the stargazers on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "description": "A template for the API URL to get information about statuses of a commit.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the subscribers on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "description": "The API URL to subscribe to notifications for this repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about tags on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the teams on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git tree of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the hooks on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/hooks" + ] + } + }, + "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" + ] + } + ], + "type": [ + "null" + ] } }, "required": [ @@ -506078,7 +506798,8 @@ "cwes", "cwe_ids", "credits", - "credits_detailed" + "credits_detailed", + "private_fork" ], "additionalProperties": false } @@ -536799,7 +537520,7 @@ } ], "previews": [], - "descriptionHTML": "

Lists your publicly visible email address, which you can set with the Set primary email visibility for the authenticated user endpoint. This endpoint is accessible with the user:email scope.

", + "descriptionHTML": "

Lists your publicly visible email address, which you can set with the Set primary email visibility for the authenticated user endpoint. This endpoint is accessible with the user:email scope.

", "statusCodes": [ { "httpStatusCode": "200", diff --git a/src/rest/data/ghae/schema.json b/src/rest/data/ghae/schema.json index d0a89b2f9c..bf5b50a24a 100644 --- a/src/rest/data/ghae/schema.json +++ b/src/rest/data/ghae/schema.json @@ -45328,7 +45328,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -47881,7 +47881,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -60210,7 +60210,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -116569,7 +116569,7 @@ } ], "previews": [], - "descriptionHTML": "

Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the security_events scope to use this endpoint. GitHub Apps must have the security_events write permission to use this endpoint.

\n

There are two places where you can upload code scanning results.

\n\n

You must compress the SARIF-formatted analysis data that you want to upload, using gzip, and then encode it as a Base64 format string. For example:

\n
gzip -c analysis-data.sarif | base64 -w0\n
\n
\nSARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above these values. For some objects there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable.\nTo get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
SARIF dataMaximum valuesAdditional limits
Runs per file15
Results per run25,000Only the top 5,000 results will be included, prioritized by severity.
Rules per run25,000
Thread Flow Locations per result10,000Only the top 1,000 Thread Flow Locations will be included, using prioritization.
Location per result1,000Only 100 locations will be included.
\n

The 202 Accepted response includes an id value.\nYou can use this ID to check the status of the upload by using it in the /sarifs/{sarif_id} endpoint.\nFor more information, see \"Get information about a SARIF upload.\"

", + "descriptionHTML": "

Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the security_events scope to use this endpoint. GitHub Apps must have the security_events write permission to use this endpoint.

\n

There are two places where you can upload code scanning results.

\n\n

You must compress the SARIF-formatted analysis data that you want to upload, using gzip, and then encode it as a Base64 format string. For example:

\n
gzip -c analysis-data.sarif | base64 -w0\n
\n
\nSARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above these values. For some objects there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable.\nTo get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
SARIF dataMaximum valuesAdditional limits
Runs per file15
Results per run25,000Only the top 5,000 results will be included, prioritized by severity.
Rules per run25,000
Thread Flow Locations per result10,000Only the top 1,000 Thread Flow Locations will be included, using prioritization.
Location per result1,000Only 100 locations will be included.
\n

The 202 Accepted response includes an id value.\nYou can use this ID to check the status of the upload by using it in the /sarifs/{sarif_id} endpoint.\nFor more information, see \"Get information about a SARIF upload.\"

", "statusCodes": [ { "httpStatusCode": "202", @@ -116693,7 +116693,7 @@ } ], "previews": [], - "descriptionHTML": "

Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see \"Get a code scanning analysis for a repository.\" You must use an access token with the security_events scope to use this endpoint with private repos, the public_repo scope also grants permission to read security events on public repos only. GitHub Apps must have the security_events read permission to use this endpoint.

", + "descriptionHTML": "

Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see \"Get a code scanning analysis for a repository.\" You must use an access token with the security_events scope to use this endpoint with private repos, the public_repo scope also grants permission to read security events on public repos only. GitHub Apps must have the security_events read permission to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -123580,7 +123580,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -153767,7 +153767,7 @@ "parameters": [ { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -155682,7 +155682,7 @@ "parameters": [ { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -156250,7 +156250,7 @@ "parameters": [ { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -165775,7 +165775,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -168826,7 +168826,7 @@ } ], "previews": [], - "descriptionHTML": "

Returns an array of references from your Git database that match the supplied name. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't exist in the repository, but existing refs start with :ref, they will be returned as an array.

\n

When you use this endpoint without providing a :ref, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just heads and tags.

\n

Note: You need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"Checking mergeability of pull requests\".

\n

If you request matching references for a branch named feature but the branch feature doesn't exist, the response can still include other matching head refs that start with the word feature, such as featureA and featureB.

", + "descriptionHTML": "

Returns an array of references from your Git database that match the supplied name. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't exist in the repository, but existing refs start with :ref, they will be returned as an array.

\n

When you use this endpoint without providing a :ref, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just heads and tags.

\n

Note: You need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"Checking mergeability of pull requests\".

\n

If you request matching references for a branch named feature but the branch feature doesn't exist, the response can still include other matching head refs that start with the word feature, such as featureA and featureB.

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

Returns a single reference from your Git database. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't match an existing ref, a 404 is returned.

\n

Note: You need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"Checking mergeability of pull requests\".

", + "descriptionHTML": "

Returns a single reference from your Git database. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't match an existing ref, a 404 is returned.

\n

Note: You need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"Checking mergeability of pull requests\".

", "statusCodes": [ { "httpStatusCode": "200", @@ -170643,7 +170643,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -174002,7 +174002,7 @@ } ], "previews": [], - "descriptionHTML": "

List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the filter query parameter to fetch issues that are not\nnecessarily assigned to you.

\n

Note: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.

", + "descriptionHTML": "

List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the filter query parameter to fetch issues that are not\nnecessarily assigned to you.

\n

Note: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -174112,7 +174112,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -177438,7 +177438,7 @@ } ], "previews": [], - "descriptionHTML": "

List issues in an organization assigned to the authenticated user.

\n

Note: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.

", + "descriptionHTML": "

List issues in an organization assigned to the authenticated user.

\n

Note: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -177567,7 +177567,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -180792,7 +180792,7 @@ } ], "previews": [], - "descriptionHTML": "

List issues in a repository. Only open issues will be listed.

\n

Note: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.

", + "descriptionHTML": "

List issues in a repository. Only open issues will be listed.

\n

Note: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.

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

The API returns a 301 Moved Permanently status if the issue was\ntransferred to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a 404 Not Found status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a 410 Gone status. To receive webhook events for transferred and deleted issues, subscribe\nto the issues webhook.

\n

Note: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.

", + "descriptionHTML": "

The API returns a 301 Moved Permanently status if the issue was\ntransferred to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a 404 Not Found status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a 410 Gone status. To receive webhook events for transferred and deleted issues, subscribe\nto the issues webhook.

\n

Note: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -190954,7 +190954,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -194277,7 +194277,7 @@ } ], "previews": [], - "descriptionHTML": "

List issues across owned and member repositories assigned to the authenticated user.

\n

Note: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.

", + "descriptionHTML": "

List issues across owned and member repositories assigned to the authenticated user.

\n

Note: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -201268,7 +201268,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -203601,7 +203601,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -293442,7 +293442,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -295455,7 +295455,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -309958,7 +309958,7 @@ } ], "previews": [], - "descriptionHTML": "

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.

\n

Pull request reviews created in the PENDING state are not submitted and therefore do not include the submitted_at property in the response. To create a pending review for a pull request, leave the event parameter blank. For more information about submitting a PENDING review, see \"Submit a review for a pull request.\"

\n

Note: To comment on a specific line in a file, you need to first determine the position of that line in the diff. The GitHub REST API offers the application/vnd.github.v3.diff media type. To see a pull request diff, add this media type to the Accept header of a call to the single pull request endpoint.

\n

The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.

", + "descriptionHTML": "

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.

\n

Pull request reviews created in the PENDING state are not submitted and therefore do not include the submitted_at property in the response. To create a pending review for a pull request, leave the event parameter blank. For more information about submitting a PENDING review, see \"Submit a review for a pull request.\"

\n

Note: To comment on a specific line in a file, you need to first determine the position of that line in the diff. The GitHub REST API offers the application/vnd.github.v3.diff media type. To see a pull request diff, add this media type to the Accept header of a call to the single pull request endpoint.

\n

The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.

", "statusCodes": [ { "httpStatusCode": "200", diff --git a/src/rest/data/ghec-2022-11-28/schema.json b/src/rest/data/ghec-2022-11-28/schema.json index 7009296d49..96bcdbfa59 100644 --- a/src/rest/data/ghec-2022-11-28/schema.json +++ b/src/rest/data/ghec-2022-11-28/schema.json @@ -82453,7 +82453,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -85006,7 +85006,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -98191,7 +98191,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -164496,7 +164496,7 @@ } ], "previews": [], - "descriptionHTML": "

Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the security_events scope to use this endpoint for private repositories. You can also use tokens with the public_repo scope for public repositories only. GitHub Apps must have the security_events write permission to use this endpoint.

\n

There are two places where you can upload code scanning results.

\n\n

You must compress the SARIF-formatted analysis data that you want to upload, using gzip, and then encode it as a Base64 format string. For example:

\n
gzip -c analysis-data.sarif | base64 -w0\n
\n
\nSARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable.\nTo get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
SARIF dataMaximum valuesAdditional limits
Runs per file20
Results per run25,000Only the top 5,000 results will be included, prioritized by severity.
Rules per run25,000
Tool extensions per run100
Thread Flow Locations per result10,000Only the top 1,000 Thread Flow Locations will be included, using prioritization.
Location per result1,000Only 100 locations will be included.
Tags per rule20Only 10 tags will be included.
\n

The 202 Accepted response includes an id value.\nYou can use this ID to check the status of the upload by using it in the /sarifs/{sarif_id} endpoint.\nFor more information, see \"Get information about a SARIF upload.\"

", + "descriptionHTML": "

Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the security_events scope to use this endpoint for private repositories. You can also use tokens with the public_repo scope for public repositories only. GitHub Apps must have the security_events write permission to use this endpoint.

\n

There are two places where you can upload code scanning results.

\n\n

You must compress the SARIF-formatted analysis data that you want to upload, using gzip, and then encode it as a Base64 format string. For example:

\n
gzip -c analysis-data.sarif | base64 -w0\n
\n
\nSARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable.\nTo get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
SARIF dataMaximum valuesAdditional limits
Runs per file20
Results per run25,000Only the top 5,000 results will be included, prioritized by severity.
Rules per run25,000
Tool extensions per run100
Thread Flow Locations per result10,000Only the top 1,000 Thread Flow Locations will be included, using prioritization.
Location per result1,000Only 100 locations will be included.
Tags per rule20Only 10 tags will be included.
\n

The 202 Accepted response includes an id value.\nYou can use this ID to check the status of the upload by using it in the /sarifs/{sarif_id} endpoint.\nFor more information, see \"Get information about a SARIF upload.\"

", "statusCodes": [ { "httpStatusCode": "202", @@ -164620,7 +164620,7 @@ } ], "previews": [], - "descriptionHTML": "

Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see \"Get a code scanning analysis for a repository.\" You must use an access token with the security_events scope to use this endpoint with private repos, the public_repo scope also grants permission to read security events on public repos only. GitHub Apps must have the security_events read permission to use this endpoint.

", + "descriptionHTML": "

Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see \"Get a code scanning analysis for a repository.\" You must use an access token with the security_events scope to use this endpoint with private repos, the public_repo scope also grants permission to read security events on public repos only. GitHub Apps must have the security_events read permission to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -211284,7 +211284,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -232175,7 +232175,7 @@ "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.

" + "description": "

Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an organization public key endpoint.

" }, { "type": "string", @@ -232199,7 +232199,7 @@ "type": "array of strings", "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.

" + "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.

" } ], "enabledForGitHubApps": true, @@ -233331,7 +233331,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 Set selected repositories for an organization secret and Remove selected repository from an organization secret endpoints.

", + "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 Set selected repositories for an organization secret and Remove selected repository from an organization secret endpoints.

", "isRequired": true } ], @@ -233360,7 +233360,7 @@ } ], "previews": [], - "descriptionHTML": "

Replaces all repositories for an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization permission to use this endpoint.

", + "descriptionHTML": "

Replaces all repositories for an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization permission to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", @@ -233425,7 +233425,7 @@ } ], "previews": [], - "descriptionHTML": "

Adds a repository to an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization permission to use this endpoint.

", + "descriptionHTML": "

Adds a repository to an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization permission to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", @@ -233494,7 +233494,7 @@ } ], "previews": [], - "descriptionHTML": "

Removes a repository from an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization permission to use this endpoint.

", + "descriptionHTML": "

Removes a repository from an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization permission to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", @@ -233861,7 +233861,7 @@ "type": "string", "name": "encrypted_value", "in": "body", - "description": "

Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint.

" + "description": "

Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint.

" }, { "type": "string", @@ -240774,7 +240774,126 @@ }, "response": { "statusCode": "200", - "description": "

List of deployment protection rules

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

List of deployment protection rules

", + "example": { + "total_count": 2, + "custom_deployment_protection_rules": [ + { + "id": 3, + "node_id": "IEH37kRlcGxveW1lbnRTdGF0ddiv", + "enabled": true, + "app": { + "id": 1, + "node_id": "GHT58kRlcGxveW1lbnRTdTY!bbcy", + "slug": "a-custom-app", + "integration_url": "https://api.github.com/apps/a-custom-app" + } + }, + { + "id": 4, + "node_id": "MDE2OkRlcGxveW1lbnRTdHJ41128", + "enabled": true, + "app": { + "id": 1, + "node_id": "UHVE67RlcGxveW1lbnRTdTY!jfeuy", + "slug": "another-custom-app", + "integration_url": "https://api.github.com/apps/another-custom-app" + } + } + ] + }, + "schema": { + "type": "object", + "properties": { + "total_count": { + "description": "The number of enabled custom deployment protection rules for this environment", + "type": "integer", + "examples": [ + 10 + ] + }, + "custom_deployment_protection_rules": { + "type": "array", + "items": { + "title": "Deployment protection rule", + "description": "Deployment protection rule", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier for the deployment protection rule.", + "examples": [ + 3515 + ] + }, + "node_id": { + "type": "string", + "description": "The node ID for the deployment protection rule.", + "examples": [ + "MDQ6R2F0ZTM1MTU=" + ] + }, + "enabled": { + "type": "boolean", + "description": "Whether the deployment protection rule is enabled for the environment.", + "examples": [ + true + ] + }, + "app": { + "title": "Custom deployment protection rule app", + "description": "A GitHub App that is providing a custom deployment protection rule.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the deployment protection rule integration.", + "examples": [ + 3515 + ] + }, + "slug": { + "type": "string", + "description": "The slugified name of the deployment protection rule integration.", + "examples": [ + "my-custom-app" + ] + }, + "integration_url": { + "type": "string", + "description": "The URL for the endpoint to get details about the app.", + "examples": [ + "https://api.github.com/apps/custom-app-slug" + ] + }, + "node_id": { + "type": "string", + "description": "The node ID for the deployment protection rule integration.", + "examples": [ + "MDQ6R2F0ZTM1MTU=" + ] + } + }, + "required": [ + "id", + "slug", + "integration_url", + "node_id" + ] + } + }, + "required": [ + "id", + "node_id", + "enabled", + "app" + ] + } + } + }, + "example": "../../components/examples/deployment_protection_rules.yaml" + } } } ], @@ -247442,7 +247561,7 @@ "parameters": [ { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -249357,7 +249476,7 @@ "parameters": [ { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -249925,7 +250044,7 @@ "parameters": [ { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -259450,7 +259569,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -262501,7 +262620,7 @@ } ], "previews": [], - "descriptionHTML": "

Returns an array of references from your Git database that match the supplied name. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't exist in the repository, but existing refs start with :ref, they will be returned as an array.

\n

When you use this endpoint without providing a :ref, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just heads and tags.

\n

Note: You need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"Checking mergeability of pull requests\".

\n

If you request matching references for a branch named feature but the branch feature doesn't exist, the response can still include other matching head refs that start with the word feature, such as featureA and featureB.

", + "descriptionHTML": "

Returns an array of references from your Git database that match the supplied name. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't exist in the repository, but existing refs start with :ref, they will be returned as an array.

\n

When you use this endpoint without providing a :ref, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just heads and tags.

\n

Note: You need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"Checking mergeability of pull requests\".

\n

If you request matching references for a branch named feature but the branch feature doesn't exist, the response can still include other matching head refs that start with the word feature, such as featureA and featureB.

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

Returns a single reference from your Git database. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't match an existing ref, a 404 is returned.

\n

Note: You need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"Checking mergeability of pull requests\".

", + "descriptionHTML": "

Returns a single reference from your Git database. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't match an existing ref, a 404 is returned.

\n

Note: You need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"Checking mergeability of pull requests\".

", "statusCodes": [ { "httpStatusCode": "200", @@ -265120,7 +265239,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -268564,7 +268683,7 @@ } ], "previews": [], - "descriptionHTML": "

List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the filter query parameter to fetch issues that are not\nnecessarily assigned to you.

\n

Note: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.

", + "descriptionHTML": "

List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the filter query parameter to fetch issues that are not\nnecessarily assigned to you.

\n

Note: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -268674,7 +268793,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -272085,7 +272204,7 @@ } ], "previews": [], - "descriptionHTML": "

List issues in an organization assigned to the authenticated user.

\n

Note: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.

", + "descriptionHTML": "

List issues in an organization assigned to the authenticated user.

\n

Note: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -272214,7 +272333,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -275524,7 +275643,7 @@ } ], "previews": [], - "descriptionHTML": "

List issues in a repository. Only open issues will be listed.

\n

Note: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.

", + "descriptionHTML": "

List issues in a repository. Only open issues will be listed.

\n

Note: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.

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

The API returns a 301 Moved Permanently status if the issue was\ntransferred to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a 404 Not Found status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a 410 Gone status. To receive webhook events for transferred and deleted issues, subscribe\nto the issues webhook.

\n

Note: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.

", + "descriptionHTML": "

The API returns a 301 Moved Permanently status if the issue was\ntransferred to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a 404 Not Found status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a 410 Gone status. To receive webhook events for transferred and deleted issues, subscribe\nto the issues webhook.

\n

Note: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -285941,7 +286060,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -289349,7 +289468,7 @@ } ], "previews": [], - "descriptionHTML": "

List issues across owned and member repositories assigned to the authenticated user.

\n

Note: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.

", + "descriptionHTML": "

List issues across owned and member repositories assigned to the authenticated user.

\n

Note: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -296510,7 +296629,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -298843,7 +298962,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -374866,22 +374985,6 @@ "enum": [ "creation" ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" } } }, @@ -374899,22 +375002,6 @@ "update" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -374942,22 +375029,6 @@ "enum": [ "deletion" ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" } } }, @@ -374974,22 +375045,6 @@ "enum": [ "required_linear_history" ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" } } }, @@ -375007,22 +375062,6 @@ "required_deployments" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -375053,22 +375092,6 @@ "enum": [ "required_signatures" ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" } } }, @@ -375086,22 +375109,6 @@ "pull_request" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -375152,22 +375159,6 @@ "required_status_checks" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -375218,22 +375209,6 @@ "enum": [ "non_fast_forward" ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" } } }, @@ -375251,22 +375226,6 @@ "commit_message_pattern" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -375314,22 +375273,6 @@ "commit_author_email_pattern" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -375377,22 +375320,6 @@ "committer_email_pattern" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -375440,22 +375367,6 @@ "branch_name_pattern" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -375503,22 +375414,6 @@ "tag_name_pattern" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -375791,25 +375686,6 @@ "enum": [ "creation" ] - }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" } ] }, @@ -375830,25 +375706,6 @@ "update" ] }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" - }, { "type": "object", "name": "parameters", @@ -375880,25 +375737,6 @@ "enum": [ "deletion" ] - }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" } ] }, @@ -375918,25 +375756,6 @@ "enum": [ "required_linear_history" ] - }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" } ] }, @@ -375957,25 +375776,6 @@ "required_deployments" ] }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" - }, { "type": "object", "name": "parameters", @@ -376007,25 +375807,6 @@ "enum": [ "required_signatures" ] - }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" } ] }, @@ -376046,25 +375827,6 @@ "pull_request" ] }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" - }, { "type": "object", "name": "parameters", @@ -376121,25 +375883,6 @@ "required_status_checks" ] }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" - }, { "type": "object", "name": "parameters", @@ -376190,25 +375933,6 @@ "enum": [ "non_fast_forward" ] - }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" } ] }, @@ -376229,25 +375953,6 @@ "commit_message_pattern" ] }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" - }, { "type": "object", "name": "parameters", @@ -376302,25 +376007,6 @@ "commit_author_email_pattern" ] }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" - }, { "type": "object", "name": "parameters", @@ -376375,25 +376061,6 @@ "committer_email_pattern" ] }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" - }, { "type": "object", "name": "parameters", @@ -376448,25 +376115,6 @@ "branch_name_pattern" ] }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" - }, { "type": "object", "name": "parameters", @@ -376521,25 +376169,6 @@ "tag_name_pattern" ] }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" - }, { "type": "object", "name": "parameters", @@ -376973,22 +376602,6 @@ "enum": [ "creation" ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" } } }, @@ -377006,22 +376619,6 @@ "update" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -377049,22 +376646,6 @@ "enum": [ "deletion" ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" } } }, @@ -377081,22 +376662,6 @@ "enum": [ "required_linear_history" ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" } } }, @@ -377114,22 +376679,6 @@ "required_deployments" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -377160,22 +376709,6 @@ "enum": [ "required_signatures" ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" } } }, @@ -377193,22 +376726,6 @@ "pull_request" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -377259,22 +376776,6 @@ "required_status_checks" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -377325,22 +376826,6 @@ "enum": [ "non_fast_forward" ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" } } }, @@ -377358,22 +376843,6 @@ "commit_message_pattern" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -377421,22 +376890,6 @@ "commit_author_email_pattern" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -377484,22 +376937,6 @@ "committer_email_pattern" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -377547,22 +376984,6 @@ "branch_name_pattern" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -377610,22 +377031,6 @@ "tag_name_pattern" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -378080,22 +377485,6 @@ "enum": [ "creation" ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" } } }, @@ -378113,22 +377502,6 @@ "update" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -378156,22 +377529,6 @@ "enum": [ "deletion" ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" } } }, @@ -378188,22 +377545,6 @@ "enum": [ "required_linear_history" ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" } } }, @@ -378221,22 +377562,6 @@ "required_deployments" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -378267,22 +377592,6 @@ "enum": [ "required_signatures" ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" } } }, @@ -378300,22 +377609,6 @@ "pull_request" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -378366,22 +377659,6 @@ "required_status_checks" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -378432,22 +377709,6 @@ "enum": [ "non_fast_forward" ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" } } }, @@ -378465,22 +377726,6 @@ "commit_message_pattern" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -378528,22 +377773,6 @@ "commit_author_email_pattern" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -378591,22 +377820,6 @@ "committer_email_pattern" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -378654,22 +377867,6 @@ "branch_name_pattern" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -378717,22 +377914,6 @@ "tag_name_pattern" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -379011,25 +378192,6 @@ "enum": [ "creation" ] - }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" } ] }, @@ -379050,25 +378212,6 @@ "update" ] }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" - }, { "type": "object", "name": "parameters", @@ -379100,25 +378243,6 @@ "enum": [ "deletion" ] - }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" } ] }, @@ -379138,25 +378262,6 @@ "enum": [ "required_linear_history" ] - }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" } ] }, @@ -379177,25 +378282,6 @@ "required_deployments" ] }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" - }, { "type": "object", "name": "parameters", @@ -379227,25 +378313,6 @@ "enum": [ "required_signatures" ] - }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" } ] }, @@ -379266,25 +378333,6 @@ "pull_request" ] }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" - }, { "type": "object", "name": "parameters", @@ -379341,25 +378389,6 @@ "required_status_checks" ] }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" - }, { "type": "object", "name": "parameters", @@ -379410,25 +378439,6 @@ "enum": [ "non_fast_forward" ] - }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" } ] }, @@ -379449,25 +378459,6 @@ "commit_message_pattern" ] }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" - }, { "type": "object", "name": "parameters", @@ -379522,25 +378513,6 @@ "commit_author_email_pattern" ] }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" - }, { "type": "object", "name": "parameters", @@ -379595,25 +378567,6 @@ "committer_email_pattern" ] }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" - }, { "type": "object", "name": "parameters", @@ -379668,25 +378621,6 @@ "branch_name_pattern" ] }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" - }, { "type": "object", "name": "parameters", @@ -379741,25 +378675,6 @@ "tag_name_pattern" ] }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" - }, { "type": "object", "name": "parameters", @@ -380194,22 +379109,6 @@ "enum": [ "creation" ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" } } }, @@ -380227,22 +379126,6 @@ "update" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -380270,22 +379153,6 @@ "enum": [ "deletion" ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" } } }, @@ -380302,22 +379169,6 @@ "enum": [ "required_linear_history" ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" } } }, @@ -380335,22 +379186,6 @@ "required_deployments" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -380381,22 +379216,6 @@ "enum": [ "required_signatures" ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" } } }, @@ -380414,22 +379233,6 @@ "pull_request" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -380480,22 +379283,6 @@ "required_status_checks" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -380546,22 +379333,6 @@ "enum": [ "non_fast_forward" ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" } } }, @@ -380579,22 +379350,6 @@ "commit_message_pattern" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -380642,22 +379397,6 @@ "commit_author_email_pattern" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -380705,22 +379444,6 @@ "committer_email_pattern" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -380768,22 +379491,6 @@ "branch_name_pattern" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -380831,22 +379538,6 @@ "tag_name_pattern" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -424229,7 +422920,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -426242,7 +424933,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -441095,7 +439786,7 @@ } ], "previews": [], - "descriptionHTML": "

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.

\n

Pull request reviews created in the PENDING state are not submitted and therefore do not include the submitted_at property in the response. To create a pending review for a pull request, leave the event parameter blank. For more information about submitting a PENDING review, see \"Submit a review for a pull request.\"

\n

Note: To comment on a specific line in a file, you need to first determine the position of that line in the diff. The GitHub REST API offers the application/vnd.github.v3.diff media type. To see a pull request diff, add this media type to the Accept header of a call to the single pull request endpoint.

\n

The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.

", + "descriptionHTML": "

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.

\n

Pull request reviews created in the PENDING state are not submitted and therefore do not include the submitted_at property in the response. To create a pending review for a pull request, leave the event parameter blank. For more information about submitting a PENDING review, see \"Submit a review for a pull request.\"

\n

Note: To comment on a specific line in a file, you need to first determine the position of that line in the diff. The GitHub REST API offers the application/vnd.github.v3.diff media type. To see a pull request diff, add this media type to the Accept header of a call to the single pull request endpoint.

\n

The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.

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

Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion comment endpoint.

\n

List the reactions to a team discussion comment. OAuth access tokens require the read:discussion scope.

", + "descriptionHTML": "

Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion comment endpoint.

\n

List the reactions to a team discussion comment. OAuth access tokens require the read:discussion scope.

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

Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"Create reaction for a team discussion comment\" endpoint.

\n

Create a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.

", + "descriptionHTML": "

Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"Create reaction for a team discussion comment\" endpoint.

\n

Create a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.

", "statusCodes": [ { "httpStatusCode": "201", @@ -452551,7 +451242,7 @@ } ], "previews": [], - "descriptionHTML": "

Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion endpoint.

\n

List the reactions to a team discussion. OAuth access tokens require the read:discussion scope.

", + "descriptionHTML": "

Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion endpoint.

\n

List the reactions to a team discussion. OAuth access tokens require the read:discussion scope.

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

Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create reaction for a team discussion endpoint.

\n

Create a reaction to a team discussion. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion.

", + "descriptionHTML": "

Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create reaction for a team discussion endpoint.

\n

Create a reaction to a team discussion. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion.

", "statusCodes": [ { "httpStatusCode": "201", @@ -496132,706 +494823,846 @@ "items": { "title": "Repository Rule", "type": "object", - "description": "A repository rule.", + "description": "A repository rule with ruleset details.", "oneOf": [ { - "title": "creation", - "description": "Only allow users with bypass permission to create matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "creation" - ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - } - } - }, - { - "title": "update", - "description": "Only allow users with bypass permission to update matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "update" - ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, - "parameters": { + "allOf": [ + { + "title": "creation", + "description": "Only allow users with bypass permission to create matching refs.", "type": "object", - "properties": { - "update_allows_fetch_and_merge": { - "type": "boolean", - "description": "Branch can pull changes from its upstream repository" - } - }, "required": [ - "update_allows_fetch_and_merge" - ] - } - } - }, - { - "title": "deletion", - "description": "Only allow users with bypass permissions to delete matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "deletion" - ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - } - } - }, - { - "title": "required_linear_history", - "description": "Prevent merge commits from being pushed to matching branches.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_linear_history" - ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - } - } - }, - { - "title": "required_deployments", - "description": "Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_deployments" - ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, - "parameters": { - "type": "object", + "type" + ], "properties": { - "required_deployment_environments": { - "type": "array", - "description": "The environments that must be successfully deployed to before branches can be merged.", - "items": { - "type": "string" - } + "type": { + "type": "string", + "enum": [ + "creation" + ] } - }, - "required": [ - "required_deployment_environments" - ] - } - } - }, - { - "title": "required_signatures", - "description": "Commits pushed to matching branches must have verified signatures.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_signatures" - ] + } }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - } - } - }, - { - "title": "pull_request", - "description": "Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "pull_request" - ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, - "parameters": { - "type": "object", + { + "title": "repository ruleset data for rule", + "description": "User-defined metadata to store domain-specific information limited to 8 keys with scalar values.", "properties": { - "dismiss_stale_reviews_on_push": { - "type": "boolean", - "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." + "ruleset_source_type": { + "type": "string", + "description": "The type of source for the ruleset that includes this rule.", + "enum": [ + "Repository", + "Organization" + ] }, - "require_code_owner_review": { - "type": "boolean", - "description": "Require an approving review in pull requests that modify files that have a designated code owner." + "ruleset_source": { + "type": "string", + "description": "The name of the source of the ruleset that includes this rule." }, - "require_last_push_approval": { - "type": "boolean", - "description": "Whether the most recent reviewable push must be approved by someone other than the person who pushed it." - }, - "required_approving_review_count": { + "ruleset_id": { "type": "integer", - "description": "The number of approving reviews that are required before a pull request can be merged.", - "minimum": 0, - "maximum": 10 - }, - "required_review_thread_resolution": { - "type": "boolean", - "description": "All conversations on code must be resolved before a pull request can be merged." + "description": "The ID of the ruleset that includes this rule." } - }, - "required": [ - "dismiss_stale_reviews_on_push", - "require_code_owner_review", - "require_last_push_approval", - "required_approving_review_count", - "required_review_thread_resolution" - ] + } } - } + ] }, { - "title": "required_status_checks", - "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_status_checks" - ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, - "parameters": { + "allOf": [ + { + "title": "update", + "description": "Only allow users with bypass permission to update matching refs.", "type": "object", + "required": [ + "type" + ], "properties": { - "required_status_checks": { - "type": "array", - "description": "Status checks that are required.", - "items": { - "title": "StatusCheckConfiguration", - "description": "Required status check", - "type": "object", - "properties": { - "context": { - "type": "string", - "description": "The status check context name that must be present on the commit." - }, - "integration_id": { - "type": "integer", - "description": "The optional integration ID that this status check must originate from." + "type": { + "type": "string", + "enum": [ + "update" + ] + }, + "parameters": { + "type": "object", + "properties": { + "update_allows_fetch_and_merge": { + "type": "boolean", + "description": "Branch can pull changes from its upstream repository" + } + }, + "required": [ + "update_allows_fetch_and_merge" + ] + } + } + }, + { + "title": "repository ruleset data for rule", + "description": "User-defined metadata to store domain-specific information limited to 8 keys with scalar values.", + "properties": { + "ruleset_source_type": { + "type": "string", + "description": "The type of source for the ruleset that includes this rule.", + "enum": [ + "Repository", + "Organization" + ] + }, + "ruleset_source": { + "type": "string", + "description": "The name of the source of the ruleset that includes this rule." + }, + "ruleset_id": { + "type": "integer", + "description": "The ID of the ruleset that includes this rule." + } + } + } + ] + }, + { + "allOf": [ + { + "title": "deletion", + "description": "Only allow users with bypass permissions to delete matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "deletion" + ] + } + } + }, + { + "title": "repository ruleset data for rule", + "description": "User-defined metadata to store domain-specific information limited to 8 keys with scalar values.", + "properties": { + "ruleset_source_type": { + "type": "string", + "description": "The type of source for the ruleset that includes this rule.", + "enum": [ + "Repository", + "Organization" + ] + }, + "ruleset_source": { + "type": "string", + "description": "The name of the source of the ruleset that includes this rule." + }, + "ruleset_id": { + "type": "integer", + "description": "The ID of the ruleset that includes this rule." + } + } + } + ] + }, + { + "allOf": [ + { + "title": "required_linear_history", + "description": "Prevent merge commits from being pushed to matching branches.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_linear_history" + ] + } + } + }, + { + "title": "repository ruleset data for rule", + "description": "User-defined metadata to store domain-specific information limited to 8 keys with scalar values.", + "properties": { + "ruleset_source_type": { + "type": "string", + "description": "The type of source for the ruleset that includes this rule.", + "enum": [ + "Repository", + "Organization" + ] + }, + "ruleset_source": { + "type": "string", + "description": "The name of the source of the ruleset that includes this rule." + }, + "ruleset_id": { + "type": "integer", + "description": "The ID of the ruleset that includes this rule." + } + } + } + ] + }, + { + "allOf": [ + { + "title": "required_deployments", + "description": "Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_deployments" + ] + }, + "parameters": { + "type": "object", + "properties": { + "required_deployment_environments": { + "type": "array", + "description": "The environments that must be successfully deployed to before branches can be merged.", + "items": { + "type": "string" + } + } + }, + "required": [ + "required_deployment_environments" + ] + } + } + }, + { + "title": "repository ruleset data for rule", + "description": "User-defined metadata to store domain-specific information limited to 8 keys with scalar values.", + "properties": { + "ruleset_source_type": { + "type": "string", + "description": "The type of source for the ruleset that includes this rule.", + "enum": [ + "Repository", + "Organization" + ] + }, + "ruleset_source": { + "type": "string", + "description": "The name of the source of the ruleset that includes this rule." + }, + "ruleset_id": { + "type": "integer", + "description": "The ID of the ruleset that includes this rule." + } + } + } + ] + }, + { + "allOf": [ + { + "title": "required_signatures", + "description": "Commits pushed to matching branches must have verified signatures.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_signatures" + ] + } + } + }, + { + "title": "repository ruleset data for rule", + "description": "User-defined metadata to store domain-specific information limited to 8 keys with scalar values.", + "properties": { + "ruleset_source_type": { + "type": "string", + "description": "The type of source for the ruleset that includes this rule.", + "enum": [ + "Repository", + "Organization" + ] + }, + "ruleset_source": { + "type": "string", + "description": "The name of the source of the ruleset that includes this rule." + }, + "ruleset_id": { + "type": "integer", + "description": "The ID of the ruleset that includes this rule." + } + } + } + ] + }, + { + "allOf": [ + { + "title": "pull_request", + "description": "Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "pull_request" + ] + }, + "parameters": { + "type": "object", + "properties": { + "dismiss_stale_reviews_on_push": { + "type": "boolean", + "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." + }, + "require_code_owner_review": { + "type": "boolean", + "description": "Require an approving review in pull requests that modify files that have a designated code owner." + }, + "require_last_push_approval": { + "type": "boolean", + "description": "Whether the most recent reviewable push must be approved by someone other than the person who pushed it." + }, + "required_approving_review_count": { + "type": "integer", + "description": "The number of approving reviews that are required before a pull request can be merged.", + "minimum": 0, + "maximum": 10 + }, + "required_review_thread_resolution": { + "type": "boolean", + "description": "All conversations on code must be resolved before a pull request can be merged." + } + }, + "required": [ + "dismiss_stale_reviews_on_push", + "require_code_owner_review", + "require_last_push_approval", + "required_approving_review_count", + "required_review_thread_resolution" + ] + } + } + }, + { + "title": "repository ruleset data for rule", + "description": "User-defined metadata to store domain-specific information limited to 8 keys with scalar values.", + "properties": { + "ruleset_source_type": { + "type": "string", + "description": "The type of source for the ruleset that includes this rule.", + "enum": [ + "Repository", + "Organization" + ] + }, + "ruleset_source": { + "type": "string", + "description": "The name of the source of the ruleset that includes this rule." + }, + "ruleset_id": { + "type": "integer", + "description": "The ID of the ruleset that includes this rule." + } + } + } + ] + }, + { + "allOf": [ + { + "title": "required_status_checks", + "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_status_checks" + ] + }, + "parameters": { + "type": "object", + "properties": { + "required_status_checks": { + "type": "array", + "description": "Status checks that are required.", + "items": { + "title": "StatusCheckConfiguration", + "description": "Required status check", + "type": "object", + "properties": { + "context": { + "type": "string", + "description": "The status check context name that must be present on the commit." + }, + "integration_id": { + "type": "integer", + "description": "The optional integration ID that this status check must originate from." + } + }, + "required": [ + "context" + ] } }, - "required": [ - "context" - ] - } - }, - "strict_required_status_checks_policy": { - "type": "boolean", - "description": "Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled." + "strict_required_status_checks_policy": { + "type": "boolean", + "description": "Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled." + } + }, + "required": [ + "required_status_checks", + "strict_required_status_checks_policy" + ] } - }, - "required": [ - "required_status_checks", - "strict_required_status_checks_policy" - ] - } - } - }, - { - "title": "non_fast_forward", - "description": "Prevent users with push access from force pushing to branches.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "non_fast_forward" - ] + } }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - } - } - }, - { - "title": "commit_message_pattern", - "description": "Parameters to be used for the commit_message_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "commit_message_pattern" - ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, - "parameters": { - "type": "object", + { + "title": "repository ruleset data for rule", + "description": "User-defined metadata to store domain-specific information limited to 8 keys with scalar values.", "properties": { - "name": { + "ruleset_source_type": { "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", + "description": "The type of source for the ruleset that includes this rule.", "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" + "Repository", + "Organization" ] }, - "pattern": { + "ruleset_source": { "type": "string", - "description": "The pattern to match with." + "description": "The name of the source of the ruleset that includes this rule." + }, + "ruleset_id": { + "type": "integer", + "description": "The ID of the ruleset that includes this rule." } - }, - "required": [ - "operator", - "pattern" - ] + } } - } + ] }, { - "title": "commit_author_email_pattern", - "description": "Parameters to be used for the commit_author_email_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "commit_author_email_pattern" - ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, - "parameters": { + "allOf": [ + { + "title": "non_fast_forward", + "description": "Prevent users with push access from force pushing to branches.", "type": "object", + "required": [ + "type" + ], "properties": { - "name": { + "type": { "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" + "non_fast_forward" + ] + } + } + }, + { + "title": "repository ruleset data for rule", + "description": "User-defined metadata to store domain-specific information limited to 8 keys with scalar values.", + "properties": { + "ruleset_source_type": { + "type": "string", + "description": "The type of source for the ruleset that includes this rule.", + "enum": [ + "Repository", + "Organization" ] }, - "pattern": { + "ruleset_source": { "type": "string", - "description": "The pattern to match with." + "description": "The name of the source of the ruleset that includes this rule." + }, + "ruleset_id": { + "type": "integer", + "description": "The ID of the ruleset that includes this rule." } - }, - "required": [ - "operator", - "pattern" - ] + } } - } + ] }, { - "title": "committer_email_pattern", - "description": "Parameters to be used for the committer_email_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "committer_email_pattern" - ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, - "parameters": { + "allOf": [ + { + "title": "commit_message_pattern", + "description": "Parameters to be used for the commit_message_pattern rule", "type": "object", + "required": [ + "type" + ], "properties": { - "name": { + "type": { "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" + "commit_message_pattern" ] }, - "pattern": { - "type": "string", - "description": "The pattern to match with." + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] } - }, - "required": [ - "operator", - "pattern" - ] + } + }, + { + "title": "repository ruleset data for rule", + "description": "User-defined metadata to store domain-specific information limited to 8 keys with scalar values.", + "properties": { + "ruleset_source_type": { + "type": "string", + "description": "The type of source for the ruleset that includes this rule.", + "enum": [ + "Repository", + "Organization" + ] + }, + "ruleset_source": { + "type": "string", + "description": "The name of the source of the ruleset that includes this rule." + }, + "ruleset_id": { + "type": "integer", + "description": "The ID of the ruleset that includes this rule." + } + } } - } + ] }, { - "title": "branch_name_pattern", - "description": "Parameters to be used for the branch_name_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "branch_name_pattern" - ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, - "parameters": { + "allOf": [ + { + "title": "commit_author_email_pattern", + "description": "Parameters to be used for the commit_author_email_pattern rule", "type": "object", + "required": [ + "type" + ], "properties": { - "name": { + "type": { "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" + "commit_author_email_pattern" ] }, - "pattern": { - "type": "string", - "description": "The pattern to match with." + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] } - }, - "required": [ - "operator", - "pattern" - ] + } + }, + { + "title": "repository ruleset data for rule", + "description": "User-defined metadata to store domain-specific information limited to 8 keys with scalar values.", + "properties": { + "ruleset_source_type": { + "type": "string", + "description": "The type of source for the ruleset that includes this rule.", + "enum": [ + "Repository", + "Organization" + ] + }, + "ruleset_source": { + "type": "string", + "description": "The name of the source of the ruleset that includes this rule." + }, + "ruleset_id": { + "type": "integer", + "description": "The ID of the ruleset that includes this rule." + } + } } - } + ] }, { - "title": "tag_name_pattern", - "description": "Parameters to be used for the tag_name_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "tag_name_pattern" - ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, - "parameters": { + "allOf": [ + { + "title": "committer_email_pattern", + "description": "Parameters to be used for the committer_email_pattern rule", "type": "object", + "required": [ + "type" + ], "properties": { - "name": { + "type": { "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" + "committer_email_pattern" ] }, - "pattern": { - "type": "string", - "description": "The pattern to match with." + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] } - }, - "required": [ - "operator", - "pattern" - ] + } + }, + { + "title": "repository ruleset data for rule", + "description": "User-defined metadata to store domain-specific information limited to 8 keys with scalar values.", + "properties": { + "ruleset_source_type": { + "type": "string", + "description": "The type of source for the ruleset that includes this rule.", + "enum": [ + "Repository", + "Organization" + ] + }, + "ruleset_source": { + "type": "string", + "description": "The name of the source of the ruleset that includes this rule." + }, + "ruleset_id": { + "type": "integer", + "description": "The ID of the ruleset that includes this rule." + } + } } - } + ] + }, + { + "allOf": [ + { + "title": "branch_name_pattern", + "description": "Parameters to be used for the branch_name_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "branch_name_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "repository ruleset data for rule", + "description": "User-defined metadata to store domain-specific information limited to 8 keys with scalar values.", + "properties": { + "ruleset_source_type": { + "type": "string", + "description": "The type of source for the ruleset that includes this rule.", + "enum": [ + "Repository", + "Organization" + ] + }, + "ruleset_source": { + "type": "string", + "description": "The name of the source of the ruleset that includes this rule." + }, + "ruleset_id": { + "type": "integer", + "description": "The ID of the ruleset that includes this rule." + } + } + } + ] + }, + { + "allOf": [ + { + "title": "tag_name_pattern", + "description": "Parameters to be used for the tag_name_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "tag_name_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "repository ruleset data for rule", + "description": "User-defined metadata to store domain-specific information limited to 8 keys with scalar values.", + "properties": { + "ruleset_source_type": { + "type": "string", + "description": "The type of source for the ruleset that includes this rule.", + "enum": [ + "Repository", + "Organization" + ] + }, + "ruleset_source": { + "type": "string", + "description": "The name of the source of the ruleset that includes this rule." + }, + "ruleset_id": { + "type": "integer", + "description": "The ID of the ruleset that includes this rule." + } + } + } + ] } ] } @@ -497248,22 +496079,6 @@ "enum": [ "creation" ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" } } }, @@ -497281,22 +496096,6 @@ "update" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -497324,22 +496123,6 @@ "enum": [ "deletion" ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" } } }, @@ -497356,22 +496139,6 @@ "enum": [ "required_linear_history" ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" } } }, @@ -497389,22 +496156,6 @@ "required_deployments" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -497435,22 +496186,6 @@ "enum": [ "required_signatures" ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" } } }, @@ -497468,22 +496203,6 @@ "pull_request" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -497534,22 +496253,6 @@ "required_status_checks" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -497600,22 +496303,6 @@ "enum": [ "non_fast_forward" ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" } } }, @@ -497633,22 +496320,6 @@ "commit_message_pattern" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -497696,22 +496367,6 @@ "commit_author_email_pattern" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -497759,22 +496414,6 @@ "committer_email_pattern" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -497822,22 +496461,6 @@ "branch_name_pattern" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -497885,22 +496508,6 @@ "tag_name_pattern" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -498108,25 +496715,6 @@ "enum": [ "creation" ] - }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" } ] }, @@ -498147,25 +496735,6 @@ "update" ] }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" - }, { "type": "object", "name": "parameters", @@ -498197,25 +496766,6 @@ "enum": [ "deletion" ] - }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" } ] }, @@ -498235,25 +496785,6 @@ "enum": [ "required_linear_history" ] - }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" } ] }, @@ -498274,25 +496805,6 @@ "required_deployments" ] }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" - }, { "type": "object", "name": "parameters", @@ -498324,25 +496836,6 @@ "enum": [ "required_signatures" ] - }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" } ] }, @@ -498363,25 +496856,6 @@ "pull_request" ] }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" - }, { "type": "object", "name": "parameters", @@ -498438,25 +496912,6 @@ "required_status_checks" ] }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" - }, { "type": "object", "name": "parameters", @@ -498507,25 +496962,6 @@ "enum": [ "non_fast_forward" ] - }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" } ] }, @@ -498546,25 +496982,6 @@ "commit_message_pattern" ] }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" - }, { "type": "object", "name": "parameters", @@ -498619,25 +497036,6 @@ "commit_author_email_pattern" ] }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" - }, { "type": "object", "name": "parameters", @@ -498692,25 +497090,6 @@ "committer_email_pattern" ] }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" - }, { "type": "object", "name": "parameters", @@ -498765,25 +497144,6 @@ "branch_name_pattern" ] }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" - }, { "type": "object", "name": "parameters", @@ -498838,25 +497198,6 @@ "tag_name_pattern" ] }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" - }, { "type": "object", "name": "parameters", @@ -499281,22 +497622,6 @@ "enum": [ "creation" ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" } } }, @@ -499314,22 +497639,6 @@ "update" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -499357,22 +497666,6 @@ "enum": [ "deletion" ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" } } }, @@ -499389,22 +497682,6 @@ "enum": [ "required_linear_history" ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" } } }, @@ -499422,22 +497699,6 @@ "required_deployments" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -499468,22 +497729,6 @@ "enum": [ "required_signatures" ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" } } }, @@ -499501,22 +497746,6 @@ "pull_request" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -499567,22 +497796,6 @@ "required_status_checks" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -499633,22 +497846,6 @@ "enum": [ "non_fast_forward" ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" } } }, @@ -499666,22 +497863,6 @@ "commit_message_pattern" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -499729,22 +497910,6 @@ "commit_author_email_pattern" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -499792,22 +497957,6 @@ "committer_email_pattern" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -499855,22 +498004,6 @@ "branch_name_pattern" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -499918,22 +498051,6 @@ "tag_name_pattern" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -500398,22 +498515,6 @@ "enum": [ "creation" ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" } } }, @@ -500431,22 +498532,6 @@ "update" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -500474,22 +498559,6 @@ "enum": [ "deletion" ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" } } }, @@ -500506,22 +498575,6 @@ "enum": [ "required_linear_history" ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" } } }, @@ -500539,22 +498592,6 @@ "required_deployments" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -500585,22 +498622,6 @@ "enum": [ "required_signatures" ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" } } }, @@ -500618,22 +498639,6 @@ "pull_request" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -500684,22 +498689,6 @@ "required_status_checks" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -500750,22 +498739,6 @@ "enum": [ "non_fast_forward" ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" } } }, @@ -500783,22 +498756,6 @@ "commit_message_pattern" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -500846,22 +498803,6 @@ "commit_author_email_pattern" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -500909,22 +498850,6 @@ "committer_email_pattern" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -500972,22 +498897,6 @@ "branch_name_pattern" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -501035,22 +498944,6 @@ "tag_name_pattern" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -501264,25 +499157,6 @@ "enum": [ "creation" ] - }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" } ] }, @@ -501303,25 +499177,6 @@ "update" ] }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" - }, { "type": "object", "name": "parameters", @@ -501353,25 +499208,6 @@ "enum": [ "deletion" ] - }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" } ] }, @@ -501391,25 +499227,6 @@ "enum": [ "required_linear_history" ] - }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" } ] }, @@ -501430,25 +499247,6 @@ "required_deployments" ] }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" - }, { "type": "object", "name": "parameters", @@ -501480,25 +499278,6 @@ "enum": [ "required_signatures" ] - }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" } ] }, @@ -501519,25 +499298,6 @@ "pull_request" ] }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" - }, { "type": "object", "name": "parameters", @@ -501594,25 +499354,6 @@ "required_status_checks" ] }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" - }, { "type": "object", "name": "parameters", @@ -501663,25 +499404,6 @@ "enum": [ "non_fast_forward" ] - }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" } ] }, @@ -501702,25 +499424,6 @@ "commit_message_pattern" ] }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" - }, { "type": "object", "name": "parameters", @@ -501775,25 +499478,6 @@ "commit_author_email_pattern" ] }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" - }, { "type": "object", "name": "parameters", @@ -501848,25 +499532,6 @@ "committer_email_pattern" ] }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" - }, { "type": "object", "name": "parameters", @@ -501921,25 +499586,6 @@ "branch_name_pattern" ] }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" - }, { "type": "object", "name": "parameters", @@ -501994,25 +499640,6 @@ "tag_name_pattern" ] }, - { - "type": "string", - "name": "ruleset_source_type", - "description": "

The type of source of the ruleset that this rule is configured in

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "ruleset_source", - "description": "

The name of the source of the ruleset that this rule is configured in

" - }, - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset that this rule is configured in

" - }, { "type": "object", "name": "parameters", @@ -502438,22 +500065,6 @@ "enum": [ "creation" ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" } } }, @@ -502471,22 +500082,6 @@ "update" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -502514,22 +500109,6 @@ "enum": [ "deletion" ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" } } }, @@ -502546,22 +500125,6 @@ "enum": [ "required_linear_history" ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" } } }, @@ -502579,22 +500142,6 @@ "required_deployments" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -502625,22 +500172,6 @@ "enum": [ "required_signatures" ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" } } }, @@ -502658,22 +500189,6 @@ "pull_request" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -502724,22 +500239,6 @@ "required_status_checks" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -502790,22 +500289,6 @@ "enum": [ "non_fast_forward" ] - }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" } } }, @@ -502823,22 +500306,6 @@ "commit_message_pattern" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -502886,22 +500353,6 @@ "commit_author_email_pattern" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -502949,22 +500400,6 @@ "committer_email_pattern" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -503012,22 +500447,6 @@ "branch_name_pattern" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -503075,22 +500494,6 @@ "tag_name_pattern" ] }, - "ruleset_source_type": { - "type": "string", - "description": "The type of source of the ruleset that this rule is configured in", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that this rule is configured in" - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that this rule is configured in" - }, "parameters": { "type": "object", "properties": { @@ -519688,6 +517091,558 @@ "additionalProperties": false }, "readOnly": true + }, + "private_fork": { + "readOnly": true, + "description": "A temporary private fork of the advisory's repository for collaborating on a fix.", + "allOf": [ + { + "title": "Simple Repository", + "description": "A GitHub repository.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "A unique identifier of the repository.", + "examples": [ + 1296269 + ] + }, + "node_id": { + "type": "string", + "description": "The GraphQL identifier of the repository.", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "type": "string", + "description": "The name of the repository.", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "description": "The full, globally unique, name of the repository.", + "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", + "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\"" + ] + } + }, + "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", + "description": "Whether the repository is private." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL to view the repository on GitHub.com.", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The repository description.", + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean", + "description": "Whether the repository is a fork." + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL to get more information about the repository from the GitHub API.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "description": "A template for the API URL to download the repository as an archive.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "description": "A template for the API URL to list the available assignees for issues in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git blob in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "description": "A template for the API URL to get information about branches in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "description": "A template for the API URL to get information about collaborators of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "description": "A template for the API URL to get information about comments on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "description": "A template for the API URL to get information about commits on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "description": "A template for the API URL to compare two commits or refs.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "description": "A template for the API URL to get the contents of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "description": "A template for the API URL to list the contributors to the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the deployments of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the downloads on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the events of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the forks of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "description": "A template for the API URL to get information about Git commits of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "description": "A template for the API URL to get information about Git refs of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "description": "A template for the API URL to get information about Git tags of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "issue_comment_url": { + "type": "string", + "description": "A template for the API URL to get information about issue comments on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "description": "A template for the API URL to get information about issue events on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "description": "A template for the API URL to get information about issues on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "description": "A template for the API URL to get information about deploy keys on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "description": "A template for the API URL to get information about labels of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about the languages of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "description": "The API URL to merge branches in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "description": "A template for the API URL to get information about milestones of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "description": "A template for the API URL to get information about notifications on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "description": "A template for the API URL to get information about pull requests on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "description": "A template for the API URL to get information about releases on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the stargazers on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "description": "A template for the API URL to get information about statuses of a commit.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the subscribers on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "description": "The API URL to subscribe to notifications for this repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about tags on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the teams on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git tree of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the hooks on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/hooks" + ] + } + }, + "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" + ] + } + ], + "type": [ + "null" + ] } }, "required": [ @@ -519713,7 +517668,8 @@ "cwes", "cwe_ids", "credits", - "credits_detailed" + "credits_detailed", + "private_fork" ], "additionalProperties": false } @@ -520959,6 +518915,558 @@ "additionalProperties": false }, "readOnly": true + }, + "private_fork": { + "readOnly": true, + "description": "A temporary private fork of the advisory's repository for collaborating on a fix.", + "allOf": [ + { + "title": "Simple Repository", + "description": "A GitHub repository.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "A unique identifier of the repository.", + "examples": [ + 1296269 + ] + }, + "node_id": { + "type": "string", + "description": "The GraphQL identifier of the repository.", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "type": "string", + "description": "The name of the repository.", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "description": "The full, globally unique, name of the repository.", + "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", + "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\"" + ] + } + }, + "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", + "description": "Whether the repository is private." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL to view the repository on GitHub.com.", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The repository description.", + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean", + "description": "Whether the repository is a fork." + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL to get more information about the repository from the GitHub API.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "description": "A template for the API URL to download the repository as an archive.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "description": "A template for the API URL to list the available assignees for issues in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git blob in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "description": "A template for the API URL to get information about branches in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "description": "A template for the API URL to get information about collaborators of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "description": "A template for the API URL to get information about comments on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "description": "A template for the API URL to get information about commits on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "description": "A template for the API URL to compare two commits or refs.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "description": "A template for the API URL to get the contents of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "description": "A template for the API URL to list the contributors to the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the deployments of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the downloads on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the events of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the forks of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "description": "A template for the API URL to get information about Git commits of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "description": "A template for the API URL to get information about Git refs of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "description": "A template for the API URL to get information about Git tags of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "issue_comment_url": { + "type": "string", + "description": "A template for the API URL to get information about issue comments on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "description": "A template for the API URL to get information about issue events on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "description": "A template for the API URL to get information about issues on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "description": "A template for the API URL to get information about deploy keys on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "description": "A template for the API URL to get information about labels of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about the languages of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "description": "The API URL to merge branches in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "description": "A template for the API URL to get information about milestones of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "description": "A template for the API URL to get information about notifications on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "description": "A template for the API URL to get information about pull requests on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "description": "A template for the API URL to get information about releases on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the stargazers on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "description": "A template for the API URL to get information about statuses of a commit.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the subscribers on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "description": "The API URL to subscribe to notifications for this repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about tags on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the teams on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git tree of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the hooks on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/hooks" + ] + } + }, + "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" + ] + } + ], + "type": [ + "null" + ] } }, "required": [ @@ -520984,7 +519492,8 @@ "cwes", "cwe_ids", "credits", - "credits_detailed" + "credits_detailed", + "private_fork" ], "additionalProperties": false } @@ -522151,6 +520660,558 @@ "additionalProperties": false }, "readOnly": true + }, + "private_fork": { + "readOnly": true, + "description": "A temporary private fork of the advisory's repository for collaborating on a fix.", + "allOf": [ + { + "title": "Simple Repository", + "description": "A GitHub repository.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "A unique identifier of the repository.", + "examples": [ + 1296269 + ] + }, + "node_id": { + "type": "string", + "description": "The GraphQL identifier of the repository.", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "type": "string", + "description": "The name of the repository.", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "description": "The full, globally unique, name of the repository.", + "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", + "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\"" + ] + } + }, + "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", + "description": "Whether the repository is private." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL to view the repository on GitHub.com.", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The repository description.", + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean", + "description": "Whether the repository is a fork." + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL to get more information about the repository from the GitHub API.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "description": "A template for the API URL to download the repository as an archive.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "description": "A template for the API URL to list the available assignees for issues in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git blob in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "description": "A template for the API URL to get information about branches in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "description": "A template for the API URL to get information about collaborators of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "description": "A template for the API URL to get information about comments on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "description": "A template for the API URL to get information about commits on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "description": "A template for the API URL to compare two commits or refs.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "description": "A template for the API URL to get the contents of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "description": "A template for the API URL to list the contributors to the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the deployments of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the downloads on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the events of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the forks of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "description": "A template for the API URL to get information about Git commits of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "description": "A template for the API URL to get information about Git refs of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "description": "A template for the API URL to get information about Git tags of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "issue_comment_url": { + "type": "string", + "description": "A template for the API URL to get information about issue comments on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "description": "A template for the API URL to get information about issue events on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "description": "A template for the API URL to get information about issues on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "description": "A template for the API URL to get information about deploy keys on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "description": "A template for the API URL to get information about labels of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about the languages of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "description": "The API URL to merge branches in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "description": "A template for the API URL to get information about milestones of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "description": "A template for the API URL to get information about notifications on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "description": "A template for the API URL to get information about pull requests on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "description": "A template for the API URL to get information about releases on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the stargazers on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "description": "A template for the API URL to get information about statuses of a commit.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the subscribers on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "description": "The API URL to subscribe to notifications for this repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about tags on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the teams on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git tree of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the hooks on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/hooks" + ] + } + }, + "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" + ] + } + ], + "type": [ + "null" + ] } }, "required": [ @@ -522176,7 +521237,8 @@ "cwes", "cwe_ids", "credits", - "credits_detailed" + "credits_detailed", + "private_fork" ], "additionalProperties": false } @@ -523265,6 +522327,558 @@ "additionalProperties": false }, "readOnly": true + }, + "private_fork": { + "readOnly": true, + "description": "A temporary private fork of the advisory's repository for collaborating on a fix.", + "allOf": [ + { + "title": "Simple Repository", + "description": "A GitHub repository.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "A unique identifier of the repository.", + "examples": [ + 1296269 + ] + }, + "node_id": { + "type": "string", + "description": "The GraphQL identifier of the repository.", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "type": "string", + "description": "The name of the repository.", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "description": "The full, globally unique, name of the repository.", + "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", + "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\"" + ] + } + }, + "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", + "description": "Whether the repository is private." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL to view the repository on GitHub.com.", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The repository description.", + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean", + "description": "Whether the repository is a fork." + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL to get more information about the repository from the GitHub API.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "description": "A template for the API URL to download the repository as an archive.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "description": "A template for the API URL to list the available assignees for issues in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git blob in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "description": "A template for the API URL to get information about branches in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "description": "A template for the API URL to get information about collaborators of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "description": "A template for the API URL to get information about comments on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "description": "A template for the API URL to get information about commits on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "description": "A template for the API URL to compare two commits or refs.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "description": "A template for the API URL to get the contents of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "description": "A template for the API URL to list the contributors to the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the deployments of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the downloads on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the events of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the forks of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "description": "A template for the API URL to get information about Git commits of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "description": "A template for the API URL to get information about Git refs of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "description": "A template for the API URL to get information about Git tags of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "issue_comment_url": { + "type": "string", + "description": "A template for the API URL to get information about issue comments on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "description": "A template for the API URL to get information about issue events on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "description": "A template for the API URL to get information about issues on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "description": "A template for the API URL to get information about deploy keys on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "description": "A template for the API URL to get information about labels of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about the languages of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "description": "The API URL to merge branches in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "description": "A template for the API URL to get information about milestones of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "description": "A template for the API URL to get information about notifications on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "description": "A template for the API URL to get information about pull requests on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "description": "A template for the API URL to get information about releases on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the stargazers on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "description": "A template for the API URL to get information about statuses of a commit.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the subscribers on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "description": "The API URL to subscribe to notifications for this repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about tags on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the teams on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git tree of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the hooks on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/hooks" + ] + } + }, + "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" + ] + } + ], + "type": [ + "null" + ] } }, "required": [ @@ -523290,7 +522904,8 @@ "cwes", "cwe_ids", "credits", - "credits_detailed" + "credits_detailed", + "private_fork" ], "additionalProperties": false } @@ -524524,6 +524139,558 @@ "additionalProperties": false }, "readOnly": true + }, + "private_fork": { + "readOnly": true, + "description": "A temporary private fork of the advisory's repository for collaborating on a fix.", + "allOf": [ + { + "title": "Simple Repository", + "description": "A GitHub repository.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "A unique identifier of the repository.", + "examples": [ + 1296269 + ] + }, + "node_id": { + "type": "string", + "description": "The GraphQL identifier of the repository.", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "type": "string", + "description": "The name of the repository.", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "description": "The full, globally unique, name of the repository.", + "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", + "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\"" + ] + } + }, + "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", + "description": "Whether the repository is private." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL to view the repository on GitHub.com.", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The repository description.", + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean", + "description": "Whether the repository is a fork." + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL to get more information about the repository from the GitHub API.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "description": "A template for the API URL to download the repository as an archive.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "description": "A template for the API URL to list the available assignees for issues in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git blob in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "description": "A template for the API URL to get information about branches in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "description": "A template for the API URL to get information about collaborators of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "description": "A template for the API URL to get information about comments on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "description": "A template for the API URL to get information about commits on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "description": "A template for the API URL to compare two commits or refs.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "description": "A template for the API URL to get the contents of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "description": "A template for the API URL to list the contributors to the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the deployments of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the downloads on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the events of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the forks of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "description": "A template for the API URL to get information about Git commits of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "description": "A template for the API URL to get information about Git refs of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "description": "A template for the API URL to get information about Git tags of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "issue_comment_url": { + "type": "string", + "description": "A template for the API URL to get information about issue comments on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "description": "A template for the API URL to get information about issue events on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "description": "A template for the API URL to get information about issues on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "description": "A template for the API URL to get information about deploy keys on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "description": "A template for the API URL to get information about labels of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about the languages of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "description": "The API URL to merge branches in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "description": "A template for the API URL to get information about milestones of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "description": "A template for the API URL to get information about notifications on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "description": "A template for the API URL to get information about pull requests on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "description": "A template for the API URL to get information about releases on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the stargazers on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "description": "A template for the API URL to get information about statuses of a commit.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the subscribers on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "description": "The API URL to subscribe to notifications for this repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about tags on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the teams on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git tree of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the hooks on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/hooks" + ] + } + }, + "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" + ] + } + ], + "type": [ + "null" + ] } }, "required": [ @@ -524549,7 +524716,8 @@ "cwes", "cwe_ids", "credits", - "credits_detailed" + "credits_detailed", + "private_fork" ], "additionalProperties": false } @@ -525586,6 +525754,558 @@ "additionalProperties": false }, "readOnly": true + }, + "private_fork": { + "readOnly": true, + "description": "A temporary private fork of the advisory's repository for collaborating on a fix.", + "allOf": [ + { + "title": "Simple Repository", + "description": "A GitHub repository.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "A unique identifier of the repository.", + "examples": [ + 1296269 + ] + }, + "node_id": { + "type": "string", + "description": "The GraphQL identifier of the repository.", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "type": "string", + "description": "The name of the repository.", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "description": "The full, globally unique, name of the repository.", + "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", + "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\"" + ] + } + }, + "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", + "description": "Whether the repository is private." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL to view the repository on GitHub.com.", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The repository description.", + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean", + "description": "Whether the repository is a fork." + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL to get more information about the repository from the GitHub API.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "description": "A template for the API URL to download the repository as an archive.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "description": "A template for the API URL to list the available assignees for issues in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git blob in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "description": "A template for the API URL to get information about branches in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "description": "A template for the API URL to get information about collaborators of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "description": "A template for the API URL to get information about comments on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "description": "A template for the API URL to get information about commits on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "description": "A template for the API URL to compare two commits or refs.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "description": "A template for the API URL to get the contents of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "description": "A template for the API URL to list the contributors to the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the deployments of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the downloads on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the events of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the forks of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "description": "A template for the API URL to get information about Git commits of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "description": "A template for the API URL to get information about Git refs of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "description": "A template for the API URL to get information about Git tags of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "issue_comment_url": { + "type": "string", + "description": "A template for the API URL to get information about issue comments on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "description": "A template for the API URL to get information about issue events on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "description": "A template for the API URL to get information about issues on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "description": "A template for the API URL to get information about deploy keys on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "description": "A template for the API URL to get information about labels of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about the languages of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "description": "The API URL to merge branches in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "description": "A template for the API URL to get information about milestones of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "description": "A template for the API URL to get information about notifications on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "description": "A template for the API URL to get information about pull requests on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "description": "A template for the API URL to get information about releases on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the stargazers on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "description": "A template for the API URL to get information about statuses of a commit.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the subscribers on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "description": "The API URL to subscribe to notifications for this repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about tags on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the teams on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git tree of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the hooks on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/hooks" + ] + } + }, + "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" + ] + } + ], + "type": [ + "null" + ] } }, "required": [ @@ -525611,7 +526331,8 @@ "cwes", "cwe_ids", "credits", - "credits_detailed" + "credits_detailed", + "private_fork" ], "additionalProperties": false } @@ -557900,7 +558621,7 @@ } ], "previews": [], - "descriptionHTML": "

Lists your publicly visible email address, which you can set with the Set primary email visibility for the authenticated user endpoint. This endpoint is accessible with the user:email scope.

", + "descriptionHTML": "

Lists your publicly visible email address, which you can set with the Set primary email visibility for the authenticated user endpoint. This endpoint is accessible with the user:email scope.

", "statusCodes": [ { "httpStatusCode": "200", diff --git a/src/rest/data/ghes-3.6/schema.json b/src/rest/data/ghes-3.6/schema.json index a807b2528b..fde483bb77 100644 --- a/src/rest/data/ghes-3.6/schema.json +++ b/src/rest/data/ghes-3.6/schema.json @@ -76873,7 +76873,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -79304,7 +79304,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -91736,7 +91736,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -151265,7 +151265,7 @@ } ], "previews": [], - "descriptionHTML": "

Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the security_events scope to use this endpoint for private repositories. You can also use tokens with the public_repo scope for public repositories only. GitHub Apps must have the security_events write permission to use this endpoint.

\n

There are two places where you can upload code scanning results.

\n\n

You must compress the SARIF-formatted analysis data that you want to upload, using gzip, and then encode it as a Base64 format string. For example:

\n
gzip -c analysis-data.sarif | base64 -w0\n
\n
\nSARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable.\nTo get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
SARIF dataMaximum valuesAdditional limits
Runs per file15
Results per run25,000Only the top 5,000 results will be included, prioritized by severity.
Rules per run25,000
Thread Flow Locations per result10,000Only the top 1,000 Thread Flow Locations will be included, using prioritization.
Location per result1,000Only 100 locations will be included.
\n

The 202 Accepted response includes an id value.\nYou can use this ID to check the status of the upload by using it in the /sarifs/{sarif_id} endpoint.\nFor more information, see \"Get information about a SARIF upload.\"

", + "descriptionHTML": "

Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the security_events scope to use this endpoint for private repositories. You can also use tokens with the public_repo scope for public repositories only. GitHub Apps must have the security_events write permission to use this endpoint.

\n

There are two places where you can upload code scanning results.

\n\n

You must compress the SARIF-formatted analysis data that you want to upload, using gzip, and then encode it as a Base64 format string. For example:

\n
gzip -c analysis-data.sarif | base64 -w0\n
\n
\nSARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable.\nTo get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
SARIF dataMaximum valuesAdditional limits
Runs per file15
Results per run25,000Only the top 5,000 results will be included, prioritized by severity.
Rules per run25,000
Thread Flow Locations per result10,000Only the top 1,000 Thread Flow Locations will be included, using prioritization.
Location per result1,000Only 100 locations will be included.
\n

The 202 Accepted response includes an id value.\nYou can use this ID to check the status of the upload by using it in the /sarifs/{sarif_id} endpoint.\nFor more information, see \"Get information about a SARIF upload.\"

", "statusCodes": [ { "httpStatusCode": "202", @@ -151389,7 +151389,7 @@ } ], "previews": [], - "descriptionHTML": "

Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see \"Get a code scanning analysis for a repository.\" You must use an access token with the security_events scope to use this endpoint with private repos, the public_repo scope also grants permission to read security events on public repos only. GitHub Apps must have the security_events read permission to use this endpoint.

", + "descriptionHTML": "

Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see \"Get a code scanning analysis for a repository.\" You must use an access token with the security_events scope to use this endpoint with private repos, the public_repo scope also grants permission to read security events on public repos only. GitHub Apps must have the security_events read permission to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -158016,7 +158016,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -172430,7 +172430,7 @@ "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.

" + "description": "

Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an organization public key endpoint.

" }, { "type": "string", @@ -172454,7 +172454,7 @@ "type": "array of strings", "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.

" + "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.

" } ], "enabledForGitHubApps": true, @@ -173525,7 +173525,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 Set selected repositories for an organization secret and Remove selected repository from an organization secret endpoints.

", + "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 Set selected repositories for an organization secret and Remove selected repository from an organization secret endpoints.

", "isRequired": true } ], @@ -173554,7 +173554,7 @@ } ], "previews": [], - "descriptionHTML": "

Replaces all repositories for an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization permission to use this endpoint.

", + "descriptionHTML": "

Replaces all repositories for an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization permission to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", @@ -173619,7 +173619,7 @@ } ], "previews": [], - "descriptionHTML": "

Adds a repository to an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization permission to use this endpoint.

", + "descriptionHTML": "

Adds a repository to an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization permission to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", @@ -173688,7 +173688,7 @@ } ], "previews": [], - "descriptionHTML": "

Removes a repository from an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization permission to use this endpoint.

", + "descriptionHTML": "

Removes a repository from an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization permission to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", @@ -174055,7 +174055,7 @@ "type": "string", "name": "encrypted_value", "in": "body", - "description": "

Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint.

" + "description": "

Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint.

" }, { "type": "string", @@ -200187,7 +200187,7 @@ "parameters": [ { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -202102,7 +202102,7 @@ "parameters": [ { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -202670,7 +202670,7 @@ "parameters": [ { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -212195,7 +212195,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -215246,7 +215246,7 @@ } ], "previews": [], - "descriptionHTML": "

Returns an array of references from your Git database that match the supplied name. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't exist in the repository, but existing refs start with :ref, they will be returned as an array.

\n

When you use this endpoint without providing a :ref, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just heads and tags.

\n

Note: You need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"Checking mergeability of pull requests\".

\n

If you request matching references for a branch named feature but the branch feature doesn't exist, the response can still include other matching head refs that start with the word feature, such as featureA and featureB.

", + "descriptionHTML": "

Returns an array of references from your Git database that match the supplied name. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't exist in the repository, but existing refs start with :ref, they will be returned as an array.

\n

When you use this endpoint without providing a :ref, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just heads and tags.

\n

Note: You need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"Checking mergeability of pull requests\".

\n

If you request matching references for a branch named feature but the branch feature doesn't exist, the response can still include other matching head refs that start with the word feature, such as featureA and featureB.

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

Returns a single reference from your Git database. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't match an existing ref, a 404 is returned.

\n

Note: You need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"Checking mergeability of pull requests\".

", + "descriptionHTML": "

Returns a single reference from your Git database. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't match an existing ref, a 404 is returned.

\n

Note: You need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"Checking mergeability of pull requests\".

", "statusCodes": [ { "httpStatusCode": "200", @@ -217063,7 +217063,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -220499,7 +220499,7 @@ } ], "previews": [], - "descriptionHTML": "

List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the filter query parameter to fetch issues that are not\nnecessarily assigned to you.

\n

Note: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.

", + "descriptionHTML": "

List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the filter query parameter to fetch issues that are not\nnecessarily assigned to you.

\n

Note: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -220609,7 +220609,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -224012,7 +224012,7 @@ } ], "previews": [], - "descriptionHTML": "

List issues in an organization assigned to the authenticated user.

\n

Note: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.

", + "descriptionHTML": "

List issues in an organization assigned to the authenticated user.

\n

Note: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -224141,7 +224141,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -227443,7 +227443,7 @@ } ], "previews": [], - "descriptionHTML": "

List issues in a repository. Only open issues will be listed.

\n

Note: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.

", + "descriptionHTML": "

List issues in a repository. Only open issues will be listed.

\n

Note: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.

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

The API returns a 301 Moved Permanently status if the issue was\ntransferred to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a 404 Not Found status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a 410 Gone status. To receive webhook events for transferred and deleted issues, subscribe\nto the issues webhook.

\n

Note: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.

", + "descriptionHTML": "

The API returns a 301 Moved Permanently status if the issue was\ntransferred to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a 404 Not Found status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a 410 Gone status. To receive webhook events for transferred and deleted issues, subscribe\nto the issues webhook.

\n

Note: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -237836,7 +237836,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -241236,7 +241236,7 @@ } ], "previews": [], - "descriptionHTML": "

List issues across owned and member repositories assigned to the authenticated user.

\n

Note: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.

", + "descriptionHTML": "

List issues across owned and member repositories assigned to the authenticated user.

\n

Note: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -248381,7 +248381,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -250714,7 +250714,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -348989,7 +348989,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -351002,7 +351002,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -365774,7 +365774,7 @@ } ], "previews": [], - "descriptionHTML": "

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.

\n

Pull request reviews created in the PENDING state are not submitted and therefore do not include the submitted_at property in the response. To create a pending review for a pull request, leave the event parameter blank. For more information about submitting a PENDING review, see \"Submit a review for a pull request.\"

\n

Note: To comment on a specific line in a file, you need to first determine the position of that line in the diff. The GitHub REST API offers the application/vnd.github.v3.diff media type. To see a pull request diff, add this media type to the Accept header of a call to the single pull request endpoint.

\n

The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.

", + "descriptionHTML": "

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.

\n

Pull request reviews created in the PENDING state are not submitted and therefore do not include the submitted_at property in the response. To create a pending review for a pull request, leave the event parameter blank. For more information about submitting a PENDING review, see \"Submit a review for a pull request.\"

\n

Note: To comment on a specific line in a file, you need to first determine the position of that line in the diff. The GitHub REST API offers the application/vnd.github.v3.diff media type. To see a pull request diff, add this media type to the Accept header of a call to the single pull request endpoint.

\n

The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.

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

Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion comment endpoint.

\n

List the reactions to a team discussion comment. OAuth access tokens require the read:discussion scope.

", + "descriptionHTML": "

Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion comment endpoint.

\n

List the reactions to a team discussion comment. OAuth access tokens require the read:discussion scope.

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

Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"Create reaction for a team discussion comment\" endpoint.

\n

Create a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.

", + "descriptionHTML": "

Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"Create reaction for a team discussion comment\" endpoint.

\n

Create a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.

", "statusCodes": [ { "httpStatusCode": "201", @@ -377206,7 +377206,7 @@ } ], "previews": [], - "descriptionHTML": "

Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion endpoint.

\n

List the reactions to a team discussion. OAuth access tokens require the read:discussion scope.

", + "descriptionHTML": "

Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion endpoint.

\n

List the reactions to a team discussion. OAuth access tokens require the read:discussion scope.

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

Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create reaction for a team discussion endpoint.

\n

Create a reaction to a team discussion. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion.

", + "descriptionHTML": "

Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create reaction for a team discussion endpoint.

\n

Create a reaction to a team discussion. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion.

", "statusCodes": [ { "httpStatusCode": "201", @@ -462140,7 +462140,7 @@ } ], "previews": [], - "descriptionHTML": "

Lists your publicly visible email address, which you can set with the Set primary email visibility for the authenticated user endpoint. This endpoint is accessible with the user:email scope.

", + "descriptionHTML": "

Lists your publicly visible email address, which you can set with the Set primary email visibility for the authenticated user endpoint. This endpoint is accessible with the user:email scope.

", "statusCodes": [ { "httpStatusCode": "200", diff --git a/src/rest/data/ghes-3.7/schema.json b/src/rest/data/ghes-3.7/schema.json index e20e8feede..6b20f7e219 100644 --- a/src/rest/data/ghes-3.7/schema.json +++ b/src/rest/data/ghes-3.7/schema.json @@ -77773,7 +77773,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -80210,7 +80210,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -92683,7 +92683,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -153683,7 +153683,7 @@ } ], "previews": [], - "descriptionHTML": "

Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the security_events scope to use this endpoint for private repositories. You can also use tokens with the public_repo scope for public repositories only. GitHub Apps must have the security_events write permission to use this endpoint.

\n

There are two places where you can upload code scanning results.

\n\n

You must compress the SARIF-formatted analysis data that you want to upload, using gzip, and then encode it as a Base64 format string. For example:

\n
gzip -c analysis-data.sarif | base64 -w0\n
\n
\nSARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable.\nTo get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
SARIF dataMaximum valuesAdditional limits
Runs per file15
Results per run25,000Only the top 5,000 results will be included, prioritized by severity.
Rules per run25,000
Thread Flow Locations per result10,000Only the top 1,000 Thread Flow Locations will be included, using prioritization.
Location per result1,000Only 100 locations will be included.
\n

The 202 Accepted response includes an id value.\nYou can use this ID to check the status of the upload by using it in the /sarifs/{sarif_id} endpoint.\nFor more information, see \"Get information about a SARIF upload.\"

", + "descriptionHTML": "

Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the security_events scope to use this endpoint for private repositories. You can also use tokens with the public_repo scope for public repositories only. GitHub Apps must have the security_events write permission to use this endpoint.

\n

There are two places where you can upload code scanning results.

\n\n

You must compress the SARIF-formatted analysis data that you want to upload, using gzip, and then encode it as a Base64 format string. For example:

\n
gzip -c analysis-data.sarif | base64 -w0\n
\n
\nSARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable.\nTo get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
SARIF dataMaximum valuesAdditional limits
Runs per file15
Results per run25,000Only the top 5,000 results will be included, prioritized by severity.
Rules per run25,000
Thread Flow Locations per result10,000Only the top 1,000 Thread Flow Locations will be included, using prioritization.
Location per result1,000Only 100 locations will be included.
\n

The 202 Accepted response includes an id value.\nYou can use this ID to check the status of the upload by using it in the /sarifs/{sarif_id} endpoint.\nFor more information, see \"Get information about a SARIF upload.\"

", "statusCodes": [ { "httpStatusCode": "202", @@ -153807,7 +153807,7 @@ } ], "previews": [], - "descriptionHTML": "

Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see \"Get a code scanning analysis for a repository.\" You must use an access token with the security_events scope to use this endpoint with private repos, the public_repo scope also grants permission to read security events on public repos only. GitHub Apps must have the security_events read permission to use this endpoint.

", + "descriptionHTML": "

Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see \"Get a code scanning analysis for a repository.\" You must use an access token with the security_events scope to use this endpoint with private repos, the public_repo scope also grants permission to read security events on public repos only. GitHub Apps must have the security_events read permission to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -160446,7 +160446,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -174879,7 +174879,7 @@ "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.

" + "description": "

Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an organization public key endpoint.

" }, { "type": "string", @@ -174903,7 +174903,7 @@ "type": "array of strings", "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.

" + "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.

" } ], "enabledForGitHubApps": true, @@ -175977,7 +175977,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 Set selected repositories for an organization secret and Remove selected repository from an organization secret endpoints.

", + "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 Set selected repositories for an organization secret and Remove selected repository from an organization secret endpoints.

", "isRequired": true } ], @@ -176006,7 +176006,7 @@ } ], "previews": [], - "descriptionHTML": "

Replaces all repositories for an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization permission to use this endpoint.

", + "descriptionHTML": "

Replaces all repositories for an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization permission to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", @@ -176071,7 +176071,7 @@ } ], "previews": [], - "descriptionHTML": "

Adds a repository to an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization permission to use this endpoint.

", + "descriptionHTML": "

Adds a repository to an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization permission to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", @@ -176140,7 +176140,7 @@ } ], "previews": [], - "descriptionHTML": "

Removes a repository from an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization permission to use this endpoint.

", + "descriptionHTML": "

Removes a repository from an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization permission to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", @@ -176507,7 +176507,7 @@ "type": "string", "name": "encrypted_value", "in": "body", - "description": "

Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint.

" + "description": "

Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint.

" }, { "type": "string", @@ -203016,7 +203016,7 @@ "parameters": [ { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -204931,7 +204931,7 @@ "parameters": [ { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -205499,7 +205499,7 @@ "parameters": [ { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -215024,7 +215024,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -218075,7 +218075,7 @@ } ], "previews": [], - "descriptionHTML": "

Returns an array of references from your Git database that match the supplied name. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't exist in the repository, but existing refs start with :ref, they will be returned as an array.

\n

When you use this endpoint without providing a :ref, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just heads and tags.

\n

Note: You need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"Checking mergeability of pull requests\".

\n

If you request matching references for a branch named feature but the branch feature doesn't exist, the response can still include other matching head refs that start with the word feature, such as featureA and featureB.

", + "descriptionHTML": "

Returns an array of references from your Git database that match the supplied name. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't exist in the repository, but existing refs start with :ref, they will be returned as an array.

\n

When you use this endpoint without providing a :ref, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just heads and tags.

\n

Note: You need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"Checking mergeability of pull requests\".

\n

If you request matching references for a branch named feature but the branch feature doesn't exist, the response can still include other matching head refs that start with the word feature, such as featureA and featureB.

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

Returns a single reference from your Git database. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't match an existing ref, a 404 is returned.

\n

Note: You need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"Checking mergeability of pull requests\".

", + "descriptionHTML": "

Returns a single reference from your Git database. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't match an existing ref, a 404 is returned.

\n

Note: You need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"Checking mergeability of pull requests\".

", "statusCodes": [ { "httpStatusCode": "200", @@ -219892,7 +219892,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -223336,7 +223336,7 @@ } ], "previews": [], - "descriptionHTML": "

List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the filter query parameter to fetch issues that are not\nnecessarily assigned to you.

\n

Note: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.

", + "descriptionHTML": "

List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the filter query parameter to fetch issues that are not\nnecessarily assigned to you.

\n

Note: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -223446,7 +223446,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -226857,7 +226857,7 @@ } ], "previews": [], - "descriptionHTML": "

List issues in an organization assigned to the authenticated user.

\n

Note: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.

", + "descriptionHTML": "

List issues in an organization assigned to the authenticated user.

\n

Note: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -226986,7 +226986,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -230296,7 +230296,7 @@ } ], "previews": [], - "descriptionHTML": "

List issues in a repository. Only open issues will be listed.

\n

Note: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.

", + "descriptionHTML": "

List issues in a repository. Only open issues will be listed.

\n

Note: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.

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

The API returns a 301 Moved Permanently status if the issue was\ntransferred to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a 404 Not Found status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a 410 Gone status. To receive webhook events for transferred and deleted issues, subscribe\nto the issues webhook.

\n

Note: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.

", + "descriptionHTML": "

The API returns a 301 Moved Permanently status if the issue was\ntransferred to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a 404 Not Found status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a 410 Gone status. To receive webhook events for transferred and deleted issues, subscribe\nto the issues webhook.

\n

Note: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -240713,7 +240713,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -244121,7 +244121,7 @@ } ], "previews": [], - "descriptionHTML": "

List issues across owned and member repositories assigned to the authenticated user.

\n

Note: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.

", + "descriptionHTML": "

List issues across owned and member repositories assigned to the authenticated user.

\n

Note: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -251282,7 +251282,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -253615,7 +253615,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -352619,7 +352619,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -354632,7 +354632,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -369436,7 +369436,7 @@ } ], "previews": [], - "descriptionHTML": "

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.

\n

Pull request reviews created in the PENDING state are not submitted and therefore do not include the submitted_at property in the response. To create a pending review for a pull request, leave the event parameter blank. For more information about submitting a PENDING review, see \"Submit a review for a pull request.\"

\n

Note: To comment on a specific line in a file, you need to first determine the position of that line in the diff. The GitHub REST API offers the application/vnd.github.v3.diff media type. To see a pull request diff, add this media type to the Accept header of a call to the single pull request endpoint.

\n

The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.

", + "descriptionHTML": "

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.

\n

Pull request reviews created in the PENDING state are not submitted and therefore do not include the submitted_at property in the response. To create a pending review for a pull request, leave the event parameter blank. For more information about submitting a PENDING review, see \"Submit a review for a pull request.\"

\n

Note: To comment on a specific line in a file, you need to first determine the position of that line in the diff. The GitHub REST API offers the application/vnd.github.v3.diff media type. To see a pull request diff, add this media type to the Accept header of a call to the single pull request endpoint.

\n

The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.

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

Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion comment endpoint.

\n

List the reactions to a team discussion comment. OAuth access tokens require the read:discussion scope.

", + "descriptionHTML": "

Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion comment endpoint.

\n

List the reactions to a team discussion comment. OAuth access tokens require the read:discussion scope.

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

Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"Create reaction for a team discussion comment\" endpoint.

\n

Create a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.

", + "descriptionHTML": "

Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"Create reaction for a team discussion comment\" endpoint.

\n

Create a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.

", "statusCodes": [ { "httpStatusCode": "201", @@ -380868,7 +380868,7 @@ } ], "previews": [], - "descriptionHTML": "

Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion endpoint.

\n

List the reactions to a team discussion. OAuth access tokens require the read:discussion scope.

", + "descriptionHTML": "

Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion endpoint.

\n

List the reactions to a team discussion. OAuth access tokens require the read:discussion scope.

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

Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create reaction for a team discussion endpoint.

\n

Create a reaction to a team discussion. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion.

", + "descriptionHTML": "

Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create reaction for a team discussion endpoint.

\n

Create a reaction to a team discussion. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion.

", "statusCodes": [ { "httpStatusCode": "201", @@ -466060,7 +466060,7 @@ } ], "previews": [], - "descriptionHTML": "

Lists your publicly visible email address, which you can set with the Set primary email visibility for the authenticated user endpoint. This endpoint is accessible with the user:email scope.

", + "descriptionHTML": "

Lists your publicly visible email address, which you can set with the Set primary email visibility for the authenticated user endpoint. This endpoint is accessible with the user:email scope.

", "statusCodes": [ { "httpStatusCode": "200", diff --git a/src/rest/data/ghes-3.8/schema.json b/src/rest/data/ghes-3.8/schema.json index 13fa0490b7..8b0fdd5bc2 100644 --- a/src/rest/data/ghes-3.8/schema.json +++ b/src/rest/data/ghes-3.8/schema.json @@ -80545,7 +80545,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -82982,7 +82982,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -95714,7 +95714,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -157054,7 +157054,7 @@ } ], "previews": [], - "descriptionHTML": "

Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the security_events scope to use this endpoint for private repositories. You can also use tokens with the public_repo scope for public repositories only. GitHub Apps must have the security_events write permission to use this endpoint.

\n

There are two places where you can upload code scanning results.

\n\n

You must compress the SARIF-formatted analysis data that you want to upload, using gzip, and then encode it as a Base64 format string. For example:

\n
gzip -c analysis-data.sarif | base64 -w0\n
\n
\nSARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable.\nTo get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
SARIF dataMaximum valuesAdditional limits
Runs per file15
Results per run25,000Only the top 5,000 results will be included, prioritized by severity.
Rules per run25,000
Tool extensions per run100
Thread Flow Locations per result10,000Only the top 1,000 Thread Flow Locations will be included, using prioritization.
Location per result1,000Only 100 locations will be included.
Tags per rule20Only 10 tags will be included.
\n

The 202 Accepted response includes an id value.\nYou can use this ID to check the status of the upload by using it in the /sarifs/{sarif_id} endpoint.\nFor more information, see \"Get information about a SARIF upload.\"

", + "descriptionHTML": "

Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the security_events scope to use this endpoint for private repositories. You can also use tokens with the public_repo scope for public repositories only. GitHub Apps must have the security_events write permission to use this endpoint.

\n

There are two places where you can upload code scanning results.

\n\n

You must compress the SARIF-formatted analysis data that you want to upload, using gzip, and then encode it as a Base64 format string. For example:

\n
gzip -c analysis-data.sarif | base64 -w0\n
\n
\nSARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable.\nTo get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
SARIF dataMaximum valuesAdditional limits
Runs per file15
Results per run25,000Only the top 5,000 results will be included, prioritized by severity.
Rules per run25,000
Tool extensions per run100
Thread Flow Locations per result10,000Only the top 1,000 Thread Flow Locations will be included, using prioritization.
Location per result1,000Only 100 locations will be included.
Tags per rule20Only 10 tags will be included.
\n

The 202 Accepted response includes an id value.\nYou can use this ID to check the status of the upload by using it in the /sarifs/{sarif_id} endpoint.\nFor more information, see \"Get information about a SARIF upload.\"

", "statusCodes": [ { "httpStatusCode": "202", @@ -157178,7 +157178,7 @@ } ], "previews": [], - "descriptionHTML": "

Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see \"Get a code scanning analysis for a repository.\" You must use an access token with the security_events scope to use this endpoint with private repos, the public_repo scope also grants permission to read security events on public repos only. GitHub Apps must have the security_events read permission to use this endpoint.

", + "descriptionHTML": "

Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see \"Get a code scanning analysis for a repository.\" You must use an access token with the security_events scope to use this endpoint with private repos, the public_repo scope also grants permission to read security events on public repos only. GitHub Apps must have the security_events read permission to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -163833,7 +163833,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -184655,7 +184655,7 @@ "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.

" + "description": "

Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an organization public key endpoint.

" }, { "type": "string", @@ -184679,7 +184679,7 @@ "type": "array of strings", "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.

" + "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.

" } ], "enabledForGitHubApps": true, @@ -185753,7 +185753,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 Set selected repositories for an organization secret and Remove selected repository from an organization secret endpoints.

", + "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 Set selected repositories for an organization secret and Remove selected repository from an organization secret endpoints.

", "isRequired": true } ], @@ -185782,7 +185782,7 @@ } ], "previews": [], - "descriptionHTML": "

Replaces all repositories for an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization permission to use this endpoint.

", + "descriptionHTML": "

Replaces all repositories for an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization permission to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", @@ -185847,7 +185847,7 @@ } ], "previews": [], - "descriptionHTML": "

Adds a repository to an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization permission to use this endpoint.

", + "descriptionHTML": "

Adds a repository to an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization permission to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", @@ -185916,7 +185916,7 @@ } ], "previews": [], - "descriptionHTML": "

Removes a repository from an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization permission to use this endpoint.

", + "descriptionHTML": "

Removes a repository from an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization permission to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", @@ -186283,7 +186283,7 @@ "type": "string", "name": "encrypted_value", "in": "body", - "description": "

Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint.

" + "description": "

Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint.

" }, { "type": "string", @@ -213053,7 +213053,7 @@ "parameters": [ { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -214968,7 +214968,7 @@ "parameters": [ { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -215536,7 +215536,7 @@ "parameters": [ { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -225061,7 +225061,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -228112,7 +228112,7 @@ } ], "previews": [], - "descriptionHTML": "

Returns an array of references from your Git database that match the supplied name. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't exist in the repository, but existing refs start with :ref, they will be returned as an array.

\n

When you use this endpoint without providing a :ref, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just heads and tags.

\n

Note: You need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"Checking mergeability of pull requests\".

\n

If you request matching references for a branch named feature but the branch feature doesn't exist, the response can still include other matching head refs that start with the word feature, such as featureA and featureB.

", + "descriptionHTML": "

Returns an array of references from your Git database that match the supplied name. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't exist in the repository, but existing refs start with :ref, they will be returned as an array.

\n

When you use this endpoint without providing a :ref, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just heads and tags.

\n

Note: You need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"Checking mergeability of pull requests\".

\n

If you request matching references for a branch named feature but the branch feature doesn't exist, the response can still include other matching head refs that start with the word feature, such as featureA and featureB.

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

Returns a single reference from your Git database. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't match an existing ref, a 404 is returned.

\n

Note: You need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"Checking mergeability of pull requests\".

", + "descriptionHTML": "

Returns a single reference from your Git database. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't match an existing ref, a 404 is returned.

\n

Note: You need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"Checking mergeability of pull requests\".

", "statusCodes": [ { "httpStatusCode": "200", @@ -229929,7 +229929,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -233373,7 +233373,7 @@ } ], "previews": [], - "descriptionHTML": "

List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the filter query parameter to fetch issues that are not\nnecessarily assigned to you.

\n

Note: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.

", + "descriptionHTML": "

List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the filter query parameter to fetch issues that are not\nnecessarily assigned to you.

\n

Note: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -233483,7 +233483,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -236894,7 +236894,7 @@ } ], "previews": [], - "descriptionHTML": "

List issues in an organization assigned to the authenticated user.

\n

Note: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.

", + "descriptionHTML": "

List issues in an organization assigned to the authenticated user.

\n

Note: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -237023,7 +237023,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -240333,7 +240333,7 @@ } ], "previews": [], - "descriptionHTML": "

List issues in a repository. Only open issues will be listed.

\n

Note: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.

", + "descriptionHTML": "

List issues in a repository. Only open issues will be listed.

\n

Note: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.

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

The API returns a 301 Moved Permanently status if the issue was\ntransferred to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a 404 Not Found status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a 410 Gone status. To receive webhook events for transferred and deleted issues, subscribe\nto the issues webhook.

\n

Note: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.

", + "descriptionHTML": "

The API returns a 301 Moved Permanently status if the issue was\ntransferred to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a 404 Not Found status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a 410 Gone status. To receive webhook events for transferred and deleted issues, subscribe\nto the issues webhook.

\n

Note: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -250750,7 +250750,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -254158,7 +254158,7 @@ } ], "previews": [], - "descriptionHTML": "

List issues across owned and member repositories assigned to the authenticated user.

\n

Note: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.

", + "descriptionHTML": "

List issues across owned and member repositories assigned to the authenticated user.

\n

Note: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -261319,7 +261319,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -263652,7 +263652,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -362784,7 +362784,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -364797,7 +364797,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -379601,7 +379601,7 @@ } ], "previews": [], - "descriptionHTML": "

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.

\n

Pull request reviews created in the PENDING state are not submitted and therefore do not include the submitted_at property in the response. To create a pending review for a pull request, leave the event parameter blank. For more information about submitting a PENDING review, see \"Submit a review for a pull request.\"

\n

Note: To comment on a specific line in a file, you need to first determine the position of that line in the diff. The GitHub REST API offers the application/vnd.github.v3.diff media type. To see a pull request diff, add this media type to the Accept header of a call to the single pull request endpoint.

\n

The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.

", + "descriptionHTML": "

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.

\n

Pull request reviews created in the PENDING state are not submitted and therefore do not include the submitted_at property in the response. To create a pending review for a pull request, leave the event parameter blank. For more information about submitting a PENDING review, see \"Submit a review for a pull request.\"

\n

Note: To comment on a specific line in a file, you need to first determine the position of that line in the diff. The GitHub REST API offers the application/vnd.github.v3.diff media type. To see a pull request diff, add this media type to the Accept header of a call to the single pull request endpoint.

\n

The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.

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

Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion comment endpoint.

\n

List the reactions to a team discussion comment. OAuth access tokens require the read:discussion scope.

", + "descriptionHTML": "

Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion comment endpoint.

\n

List the reactions to a team discussion comment. OAuth access tokens require the read:discussion scope.

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

Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"Create reaction for a team discussion comment\" endpoint.

\n

Create a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.

", + "descriptionHTML": "

Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"Create reaction for a team discussion comment\" endpoint.

\n

Create a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.

", "statusCodes": [ { "httpStatusCode": "201", @@ -391033,7 +391033,7 @@ } ], "previews": [], - "descriptionHTML": "

Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion endpoint.

\n

List the reactions to a team discussion. OAuth access tokens require the read:discussion scope.

", + "descriptionHTML": "

Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion endpoint.

\n

List the reactions to a team discussion. OAuth access tokens require the read:discussion scope.

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

Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create reaction for a team discussion endpoint.

\n

Create a reaction to a team discussion. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion.

", + "descriptionHTML": "

Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create reaction for a team discussion endpoint.

\n

Create a reaction to a team discussion. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion.

", "statusCodes": [ { "httpStatusCode": "201", @@ -476353,7 +476353,7 @@ } ], "previews": [], - "descriptionHTML": "

Lists your publicly visible email address, which you can set with the Set primary email visibility for the authenticated user endpoint. This endpoint is accessible with the user:email scope.

", + "descriptionHTML": "

Lists your publicly visible email address, which you can set with the Set primary email visibility for the authenticated user endpoint. This endpoint is accessible with the user:email scope.

", "statusCodes": [ { "httpStatusCode": "200", diff --git a/src/rest/data/ghes-3.9-2022-11-28/schema.json b/src/rest/data/ghes-3.9-2022-11-28/schema.json index da2161a77d..6a2fadc930 100644 --- a/src/rest/data/ghes-3.9-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.9-2022-11-28/schema.json @@ -81335,7 +81335,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -83860,7 +83860,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -96746,7 +96746,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -158677,7 +158677,7 @@ } ], "previews": [], - "descriptionHTML": "

Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the security_events scope to use this endpoint for private repositories. You can also use tokens with the public_repo scope for public repositories only. GitHub Apps must have the security_events write permission to use this endpoint.

\n

There are two places where you can upload code scanning results.

\n\n

You must compress the SARIF-formatted analysis data that you want to upload, using gzip, and then encode it as a Base64 format string. For example:

\n
gzip -c analysis-data.sarif | base64 -w0\n
\n
\nSARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable.\nTo get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
SARIF dataMaximum valuesAdditional limits
Runs per file20
Results per run25,000Only the top 5,000 results will be included, prioritized by severity.
Rules per run25,000
Tool extensions per run100
Thread Flow Locations per result10,000Only the top 1,000 Thread Flow Locations will be included, using prioritization.
Location per result1,000Only 100 locations will be included.
Tags per rule20Only 10 tags will be included.
\n

The 202 Accepted response includes an id value.\nYou can use this ID to check the status of the upload by using it in the /sarifs/{sarif_id} endpoint.\nFor more information, see \"Get information about a SARIF upload.\"

", + "descriptionHTML": "

Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the security_events scope to use this endpoint for private repositories. You can also use tokens with the public_repo scope for public repositories only. GitHub Apps must have the security_events write permission to use this endpoint.

\n

There are two places where you can upload code scanning results.

\n\n

You must compress the SARIF-formatted analysis data that you want to upload, using gzip, and then encode it as a Base64 format string. For example:

\n
gzip -c analysis-data.sarif | base64 -w0\n
\n
\nSARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable.\nTo get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
SARIF dataMaximum valuesAdditional limits
Runs per file20
Results per run25,000Only the top 5,000 results will be included, prioritized by severity.
Rules per run25,000
Tool extensions per run100
Thread Flow Locations per result10,000Only the top 1,000 Thread Flow Locations will be included, using prioritization.
Location per result1,000Only 100 locations will be included.
Tags per rule20Only 10 tags will be included.
\n

The 202 Accepted response includes an id value.\nYou can use this ID to check the status of the upload by using it in the /sarifs/{sarif_id} endpoint.\nFor more information, see \"Get information about a SARIF upload.\"

", "statusCodes": [ { "httpStatusCode": "202", @@ -158801,7 +158801,7 @@ } ], "previews": [], - "descriptionHTML": "

Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see \"Get a code scanning analysis for a repository.\" You must use an access token with the security_events scope to use this endpoint with private repos, the public_repo scope also grants permission to read security events on public repos only. GitHub Apps must have the security_events read permission to use this endpoint.

", + "descriptionHTML": "

Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see \"Get a code scanning analysis for a repository.\" You must use an access token with the security_events scope to use this endpoint with private repos, the public_repo scope also grants permission to read security events on public repos only. GitHub Apps must have the security_events read permission to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -165632,7 +165632,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -186498,7 +186498,7 @@ "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.

" + "description": "

Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an organization public key endpoint.

" }, { "type": "string", @@ -186522,7 +186522,7 @@ "type": "array of strings", "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.

" + "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.

" } ], "enabledForGitHubApps": true, @@ -187640,7 +187640,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 Set selected repositories for an organization secret and Remove selected repository from an organization secret endpoints.

", + "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 Set selected repositories for an organization secret and Remove selected repository from an organization secret endpoints.

", "isRequired": true } ], @@ -187669,7 +187669,7 @@ } ], "previews": [], - "descriptionHTML": "

Replaces all repositories for an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization permission to use this endpoint.

", + "descriptionHTML": "

Replaces all repositories for an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization permission to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", @@ -187734,7 +187734,7 @@ } ], "previews": [], - "descriptionHTML": "

Adds a repository to an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization permission to use this endpoint.

", + "descriptionHTML": "

Adds a repository to an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization permission to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", @@ -187803,7 +187803,7 @@ } ], "previews": [], - "descriptionHTML": "

Removes a repository from an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization permission to use this endpoint.

", + "descriptionHTML": "

Removes a repository from an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization permission to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", @@ -188170,7 +188170,7 @@ "type": "string", "name": "encrypted_value", "in": "body", - "description": "

Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint.

" + "description": "

Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint.

" }, { "type": "string", @@ -215727,7 +215727,7 @@ "parameters": [ { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -217642,7 +217642,7 @@ "parameters": [ { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -218210,7 +218210,7 @@ "parameters": [ { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -227735,7 +227735,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -230786,7 +230786,7 @@ } ], "previews": [], - "descriptionHTML": "

Returns an array of references from your Git database that match the supplied name. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't exist in the repository, but existing refs start with :ref, they will be returned as an array.

\n

When you use this endpoint without providing a :ref, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just heads and tags.

\n

Note: You need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"Checking mergeability of pull requests\".

\n

If you request matching references for a branch named feature but the branch feature doesn't exist, the response can still include other matching head refs that start with the word feature, such as featureA and featureB.

", + "descriptionHTML": "

Returns an array of references from your Git database that match the supplied name. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't exist in the repository, but existing refs start with :ref, they will be returned as an array.

\n

When you use this endpoint without providing a :ref, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just heads and tags.

\n

Note: You need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"Checking mergeability of pull requests\".

\n

If you request matching references for a branch named feature but the branch feature doesn't exist, the response can still include other matching head refs that start with the word feature, such as featureA and featureB.

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

Returns a single reference from your Git database. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't match an existing ref, a 404 is returned.

\n

Note: You need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"Checking mergeability of pull requests\".

", + "descriptionHTML": "

Returns a single reference from your Git database. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't match an existing ref, a 404 is returned.

\n

Note: You need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"Checking mergeability of pull requests\".

", "statusCodes": [ { "httpStatusCode": "200", @@ -232603,7 +232603,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -236047,7 +236047,7 @@ } ], "previews": [], - "descriptionHTML": "

List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the filter query parameter to fetch issues that are not\nnecessarily assigned to you.

\n

Note: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.

", + "descriptionHTML": "

List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the filter query parameter to fetch issues that are not\nnecessarily assigned to you.

\n

Note: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -236157,7 +236157,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -239568,7 +239568,7 @@ } ], "previews": [], - "descriptionHTML": "

List issues in an organization assigned to the authenticated user.

\n

Note: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.

", + "descriptionHTML": "

List issues in an organization assigned to the authenticated user.

\n

Note: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -239697,7 +239697,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -243007,7 +243007,7 @@ } ], "previews": [], - "descriptionHTML": "

List issues in a repository. Only open issues will be listed.

\n

Note: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.

", + "descriptionHTML": "

List issues in a repository. Only open issues will be listed.

\n

Note: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.

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

The API returns a 301 Moved Permanently status if the issue was\ntransferred to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a 404 Not Found status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a 410 Gone status. To receive webhook events for transferred and deleted issues, subscribe\nto the issues webhook.

\n

Note: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.

", + "descriptionHTML": "

The API returns a 301 Moved Permanently status if the issue was\ntransferred to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a 404 Not Found status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a 410 Gone status. To receive webhook events for transferred and deleted issues, subscribe\nto the issues webhook.

\n

Note: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -253424,7 +253424,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -256832,7 +256832,7 @@ } ], "previews": [], - "descriptionHTML": "

List issues across owned and member repositories assigned to the authenticated user.

\n

Note: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.

", + "descriptionHTML": "

List issues across owned and member repositories assigned to the authenticated user.

\n

Note: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -263993,7 +263993,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -266326,7 +266326,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -380662,7 +380662,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -382675,7 +382675,7 @@ }, { "name": "since", - "description": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "in": "query", "required": false, "schema": { @@ -397489,7 +397489,7 @@ } ], "previews": [], - "descriptionHTML": "

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.

\n

Pull request reviews created in the PENDING state are not submitted and therefore do not include the submitted_at property in the response. To create a pending review for a pull request, leave the event parameter blank. For more information about submitting a PENDING review, see \"Submit a review for a pull request.\"

\n

Note: To comment on a specific line in a file, you need to first determine the position of that line in the diff. The GitHub REST API offers the application/vnd.github.v3.diff media type. To see a pull request diff, add this media type to the Accept header of a call to the single pull request endpoint.

\n

The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.

", + "descriptionHTML": "

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.

\n

Pull request reviews created in the PENDING state are not submitted and therefore do not include the submitted_at property in the response. To create a pending review for a pull request, leave the event parameter blank. For more information about submitting a PENDING review, see \"Submit a review for a pull request.\"

\n

Note: To comment on a specific line in a file, you need to first determine the position of that line in the diff. The GitHub REST API offers the application/vnd.github.v3.diff media type. To see a pull request diff, add this media type to the Accept header of a call to the single pull request endpoint.

\n

The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.

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

Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion comment endpoint.

\n

List the reactions to a team discussion comment. OAuth access tokens require the read:discussion scope.

", + "descriptionHTML": "

Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion comment endpoint.

\n

List the reactions to a team discussion comment. OAuth access tokens require the read:discussion scope.

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

Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"Create reaction for a team discussion comment\" endpoint.

\n

Create a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.

", + "descriptionHTML": "

Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"Create reaction for a team discussion comment\" endpoint.

\n

Create a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.

", "statusCodes": [ { "httpStatusCode": "201", @@ -408921,7 +408921,7 @@ } ], "previews": [], - "descriptionHTML": "

Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion endpoint.

\n

List the reactions to a team discussion. OAuth access tokens require the read:discussion scope.

", + "descriptionHTML": "

Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion endpoint.

\n

List the reactions to a team discussion. OAuth access tokens require the read:discussion scope.

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

Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create reaction for a team discussion endpoint.

\n

Create a reaction to a team discussion. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion.

", + "descriptionHTML": "

Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create reaction for a team discussion endpoint.

\n

Create a reaction to a team discussion. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion.

", "statusCodes": [ { "httpStatusCode": "201", @@ -494850,7 +494850,7 @@ } ], "previews": [], - "descriptionHTML": "

Lists your publicly visible email address, which you can set with the Set primary email visibility for the authenticated user endpoint. This endpoint is accessible with the user:email scope.

", + "descriptionHTML": "

Lists your publicly visible email address, which you can set with the Set primary email visibility for the authenticated user endpoint. This endpoint is accessible with the user:email scope.

", "statusCodes": [ { "httpStatusCode": "200", diff --git a/src/rest/lib/config.json b/src/rest/lib/config.json index 0088481a78..55deedebbe 100644 --- a/src/rest/lib/config.json +++ b/src/rest/lib/config.json @@ -33,5 +33,5 @@ ] } }, - "sha": "2b5555bb39f20fc261e2da7b32825391518a900a" + "sha": "4bcf31ad7b9b05793f9857f379fcfc1f4d8bb06b" } \ No newline at end of file diff --git a/src/webhooks/data/fpt/schema.json b/src/webhooks/data/fpt/schema.json index 76d25a6525..7a185e01b8 100644 --- a/src/webhooks/data/fpt/schema.json +++ b/src/webhooks/data/fpt/schema.json @@ -66509,7 +66509,7 @@ }, "destroyed": { "descriptionHtml": "

The merge queue groups pull requests together to be merged. This event indicates that one of those merge groups was destroyed. This happens when a pull request is removed from the queue: any group containing that pull request is also destroyed.

\n

When you receive this event, you may want to cancel any checks that are running on the head SHA to avoid wasting computing resources on a merge group that will not be used.

", - "summaryHtml": "

This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"Managing a merge queue.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.

\n

Note: The pull request merge queue feature is currently in public beta and subject to change.

", + "summaryHtml": "

This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"Managing a merge queue.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -94522,7 +94522,7 @@ "category": "pull_request" }, "dequeued": { - "descriptionHtml": "

A pull request was removed from the merge queue.

\n

Note: The pull request merge queue feature is currently in limited public beta and subject to change.

", + "descriptionHtml": "

A pull request was removed from the merge queue.

", "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", "bodyParameters": [ { @@ -97885,7 +97885,7 @@ "category": "pull_request" }, "enqueued": { - "descriptionHtml": "

A pull request was added to the merge queue.

\n

Note: The pull request merge queue feature is currently in limited public beta and subject to change.

", + "descriptionHtml": "

A pull request was added to the merge queue.

", "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", "bodyParameters": [ { @@ -163259,6 +163259,12 @@ ] } ] + }, + { + "type": "null", + "name": "private_fork", + "description": "

A temporary private fork of the advisory's repository for collaborating on a fix.

", + "isRequired": true } ] }, @@ -163775,6 +163781,12 @@ ] } ] + }, + { + "type": "null", + "name": "private_fork", + "description": "

A temporary private fork of the advisory's repository for collaborating on a fix.

", + "isRequired": true } ] }, diff --git a/src/webhooks/data/ghec/schema.json b/src/webhooks/data/ghec/schema.json index 5a4186598d..133c190a83 100644 --- a/src/webhooks/data/ghec/schema.json +++ b/src/webhooks/data/ghec/schema.json @@ -66509,7 +66509,7 @@ }, "destroyed": { "descriptionHtml": "

The merge queue groups pull requests together to be merged. This event indicates that one of those merge groups was destroyed. This happens when a pull request is removed from the queue: any group containing that pull request is also destroyed.

\n

When you receive this event, you may want to cancel any checks that are running on the head SHA to avoid wasting computing resources on a merge group that will not be used.

", - "summaryHtml": "

This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"Managing a merge queue.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.

\n

Note: The pull request merge queue feature is currently in public beta and subject to change.

", + "summaryHtml": "

This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"Managing a merge queue.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -94522,7 +94522,7 @@ "category": "pull_request" }, "dequeued": { - "descriptionHtml": "

A pull request was removed from the merge queue.

\n

Note: The pull request merge queue feature is currently in limited public beta and subject to change.

", + "descriptionHtml": "

A pull request was removed from the merge queue.

", "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", "bodyParameters": [ { @@ -97885,7 +97885,7 @@ "category": "pull_request" }, "enqueued": { - "descriptionHtml": "

A pull request was added to the merge queue.

\n

Note: The pull request merge queue feature is currently in limited public beta and subject to change.

", + "descriptionHtml": "

A pull request was added to the merge queue.

", "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", "bodyParameters": [ { @@ -163259,6 +163259,12 @@ ] } ] + }, + { + "type": "null", + "name": "private_fork", + "description": "

A temporary private fork of the advisory's repository for collaborating on a fix.

", + "isRequired": true } ] }, @@ -163775,6 +163781,12 @@ ] } ] + }, + { + "type": "null", + "name": "private_fork", + "description": "

A temporary private fork of the advisory's repository for collaborating on a fix.

", + "isRequired": true } ] }, diff --git a/src/webhooks/lib/config.json b/src/webhooks/lib/config.json index 10fc54bc17..9efe2860a4 100644 --- a/src/webhooks/lib/config.json +++ b/src/webhooks/lib/config.json @@ -1,3 +1,3 @@ { - "sha": "2b5555bb39f20fc261e2da7b32825391518a900a" + "sha": "4bcf31ad7b9b05793f9857f379fcfc1f4d8bb06b" } \ No newline at end of file