From 792196389276fd46653662744fa73db6a76096dc Mon Sep 17 00:00:00 2001 From: docubot <67483024+docubot@users.noreply.github.com> Date: Tue, 18 Apr 2023 12:53:27 -0700 Subject: [PATCH] Update OpenAPI Description (#36471) Co-authored-by: Sarah Edwards --- content/rest/deployments/index.md | 7 +- content/rest/deployments/protection-rules.md | 14 + .../fpt-2022-11-28/server-to-server-rest.json | 42 + .../server-to-server-rest.json | 42 + src/github-apps/lib/config.json | 2 +- .../data/client-side-rest-api-redirects.json | 7 + src/rest/data/fpt-2022-11-28/schema.json | 3146 +++++++++++--- src/rest/data/ghae/schema.json | 2 +- src/rest/data/ghec-2022-11-28/schema.json | 3146 +++++++++++--- src/rest/data/ghes-3.4/schema.json | 2 +- src/rest/data/ghes-3.5/schema.json | 2 +- src/rest/data/ghes-3.6/schema.json | 2 +- src/rest/data/ghes-3.7/schema.json | 2 +- src/rest/data/ghes-3.8/schema.json | 2 +- src/rest/lib/config.json | 2 +- src/webhooks/data/fpt/schema.json | 3739 +++++++++++++++++ src/webhooks/data/ghae/schema.json | 3739 +++++++++++++++++ src/webhooks/data/ghec/schema.json | 3739 +++++++++++++++++ src/webhooks/lib/config.json | 2 +- 19 files changed, 16376 insertions(+), 1263 deletions(-) create mode 100644 content/rest/deployments/protection-rules.md diff --git a/content/rest/deployments/index.md b/content/rest/deployments/index.md index a419d90860b7..c430625c3eb1 100644 --- a/content/rest/deployments/index.md +++ b/content/rest/deployments/index.md @@ -1,6 +1,8 @@ --- title: Deployments -intro: 'Use the REST API to create and delete deploy keys, deployments, and deployment environments.' +intro: >- + Use the REST API to create and delete deploy keys, deployments, and deployment + environments. allowTitleToDifferFromFilename: true versions: fpt: '*' @@ -10,10 +12,11 @@ versions: topics: - API children: + - /branch-policies - /deployments - /environments + - /protection-rules - /statuses - - /branch-policies redirect_from: - /rest/reference/deployments autogenerated: rest diff --git a/content/rest/deployments/protection-rules.md b/content/rest/deployments/protection-rules.md new file mode 100644 index 000000000000..578dcea89950 --- /dev/null +++ b/content/rest/deployments/protection-rules.md @@ -0,0 +1,14 @@ +--- +title: Protection rules +shortTitle: Protection rules +intro: 'Use the REST API to create, configure, and delete deployment protection rules.' +versions: + fpt: '*' + ghec: '*' +topics: + - API +autogenerated: rest +allowTitleToDifferFromFilename: true +--- + + diff --git a/src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json b/src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json index 409b6d1822ea..604d651c79d7 100644 --- a/src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json +++ b/src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json @@ -594,6 +594,12 @@ "verb": "post", "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/cancel" }, + { + "slug": "review-custom-deployment-protection-rules-for-a-workflow-run", + "subcategory": "workflow-runs", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/deployment_protection_rule" + }, { "slug": "list-jobs-for-a-workflow-run", "subcategory": "workflow-jobs", @@ -1735,6 +1741,36 @@ "subcategory": "branch-policies", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}" + }, + { + "slug": "get-all-deployment-protection-rules-for-an-environment", + "subcategory": "protection-rules", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules" + }, + { + "slug": "create-a-custom-deployment-protection-rule-on-an-environment", + "subcategory": "protection-rules", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules" + }, + { + "slug": "list-custom-deployment-rule-integrations-available-for-an-environment", + "subcategory": "protection-rules", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/apps" + }, + { + "slug": "get-a-custom-deployment-protection-rule", + "subcategory": "protection-rules", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/{protection_rule_id}" + }, + { + "slug": "disable-a-custom-protection-rule-for-an-environment", + "subcategory": "protection-rules", + "verb": "delete", + "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/{protection_rule_id}" } ], "emojis": [ @@ -3530,6 +3566,12 @@ "verb": "post", "requestPath": "/repos/{owner}/{repo}/security-advisories" }, + { + "slug": "privately-report-a-security-vulnerability", + "subcategory": "repository-advisories", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/security-advisories/reports" + }, { "slug": "get-a-repository-security-advisory", "subcategory": "repository-advisories", diff --git a/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json b/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json index fc6c2f5d545f..34f16371677f 100644 --- a/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json +++ b/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json @@ -672,6 +672,12 @@ "verb": "post", "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/cancel" }, + { + "slug": "review-custom-deployment-protection-rules-for-a-workflow-run", + "subcategory": "workflow-runs", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/deployment_protection_rule" + }, { "slug": "list-jobs-for-a-workflow-run", "subcategory": "workflow-jobs", @@ -1841,6 +1847,36 @@ "subcategory": "branch-policies", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}" + }, + { + "slug": "get-all-deployment-protection-rules-for-an-environment", + "subcategory": "protection-rules", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules" + }, + { + "slug": "create-a-custom-deployment-protection-rule-on-an-environment", + "subcategory": "protection-rules", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules" + }, + { + "slug": "list-custom-deployment-rule-integrations-available-for-an-environment", + "subcategory": "protection-rules", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/apps" + }, + { + "slug": "get-a-custom-deployment-protection-rule", + "subcategory": "protection-rules", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/{protection_rule_id}" + }, + { + "slug": "disable-a-custom-protection-rule-for-an-environment", + "subcategory": "protection-rules", + "verb": "delete", + "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/{protection_rule_id}" } ], "emojis": [ @@ -3764,6 +3800,12 @@ "verb": "post", "requestPath": "/repos/{owner}/{repo}/security-advisories" }, + { + "slug": "privately-report-a-security-vulnerability", + "subcategory": "repository-advisories", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/security-advisories/reports" + }, { "slug": "get-a-repository-security-advisory", "subcategory": "repository-advisories", diff --git a/src/github-apps/lib/config.json b/src/github-apps/lib/config.json index 9a98288a9698..01e3f5247f3f 100644 --- a/src/github-apps/lib/config.json +++ b/src/github-apps/lib/config.json @@ -1,3 +1,3 @@ { - "sha": "955d6a6a61c413f2940b977647300f1c609b0ec6" + "sha": "cf133481cb255f2119fe875dcfde3e047d2017b7" } \ No newline at end of file diff --git a/src/rest/data/client-side-rest-api-redirects.json b/src/rest/data/client-side-rest-api-redirects.json index 8d063b647583..da71538bf8f0 100644 --- a/src/rest/data/client-side-rest-api-redirects.json +++ b/src/rest/data/client-side-rest-api-redirects.json @@ -493,6 +493,7 @@ "/rest/actions#list-jobs-for-a-workflow-run-attempt": "/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt", "/rest/actions#download-workflow-run-attempt-logs": "/rest/actions/workflow-runs#download-workflow-run-attempt-logs", "/rest/actions#cancel-a-workflow-run": "/rest/actions/workflow-runs#cancel-a-workflow-run", + "/rest/actions/workflow-runs#review-custom-deployment-protection-rules-for-a-workflow-run": "/rest/actions/workflow-runs#review-custom-deployment-protection-rules-for-a-workflow-run", "/rest/actions#list-jobs-for-a-workflow-run": "/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run", "/rest/actions#download-workflow-run-logs": "/rest/actions/workflow-runs#download-workflow-run-logs", "/rest/actions#delete-workflow-run-logs": "/rest/actions/workflow-runs#delete-workflow-run-logs", @@ -654,6 +655,11 @@ "/rest/deployments/branch-policies#get-deployment-branch-policy": "/rest/deployments/branch-policies#get-deployment-branch-policy", "/rest/deployments/branch-policies#update-deployment-branch-policy": "/rest/deployments/branch-policies#update-deployment-branch-policy", "/rest/deployments/branch-policies#delete-deployment-branch-policy": "/rest/deployments/branch-policies#delete-deployment-branch-policy", + "/rest/deployments/protection-rules#get-all-deployment-protection-rules": "/rest/deployments/protection-rules#get-all-deployment-protection-rules", + "/rest/deployments#protection-rules": "/rest/deployments/protection-rules", + "/rest/deployments/protection-rules#list-custom-deployment-rule-integrations": "/rest/deployments/protection-rules#list-custom-deployment-rule-integrations", + "/rest/deployments/protection-rules#get-a-deployment-protection-rule": "/rest/deployments/protection-rules#get-a-deployment-protection-rule", + "/rest/deployments/protection-rules#disable-deployment-protection-rule": "/rest/deployments/protection-rules#disable-deployment-protection-rule", "/rest/activity#list-repository-events": "/rest/activity/events#list-repository-events", "/rest/repos#list-forks": "/rest/repos/forks#list-forks", "/rest/repos#forks": "/rest/repos/forks", @@ -803,6 +809,7 @@ "/rest/security-advisories/repository-advisories#list-repository-security-advisories": "/rest/security-advisories/repository-advisories#list-repository-security-advisories", "/rest/security-advisories#repository-advisories": "/rest/security-advisories/repository-advisories", "/rest/security-advisories/repository-advisories#create-a-repository-security-advisory": "/rest/security-advisories/repository-advisories#create-a-repository-security-advisory", + "/rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability": "/rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability", "/rest/security-advisories/repository-advisories#get-a-repository-security-advisory": "/rest/security-advisories/repository-advisories#get-a-repository-security-advisory", "/rest/security-advisories/repository-advisories#update-a-repository-security-advisory": "/rest/security-advisories/repository-advisories#update-a-repository-security-advisory", "/rest/activity#list-stargazers": "/rest/activity/starring#list-stargazers", diff --git a/src/rest/data/fpt-2022-11-28/schema.json b/src/rest/data/fpt-2022-11-28/schema.json index b7463deecb3c..bb7c6c3f029b 100644 --- a/src/rest/data/fpt-2022-11-28/schema.json +++ b/src/rest/data/fpt-2022-11-28/schema.json @@ -40881,6 +40881,77 @@ } ] }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/deployment_protection_rule", + "title": "Review custom deployment protection rules for a workflow run", + "category": "actions", + "subcategory": "workflow-runs", + "parameters": [ + { + "name": "owner", + "description": "

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

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

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

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

The unique identifier of the workflow run.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "environment_name": "prod-eus", + "state": "approved", + "comment": "All health checks passed." + }, + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "run_id": "RUN_ID" + } + }, + "response": { + "statusCode": "204", + "description": "

Response

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

Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see \"Using environments for deployment.\"

\n

Note: GitHub Apps can only review their own custom deployment protection rules.\nTo approve or reject pending deployments that are waiting for review from a specific person or team, see POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments.

\n

GitHub Apps must have read and write permission for Deployments to use this endpoint.

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

No Content

" + } + ] + }, { "serverUrl": "https://api.github.com", "verb": "get", @@ -62477,8 +62548,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

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

", "statusCodes": [ { "httpStatusCode": "200", @@ -162454,8 +162525,13 @@ "items": { "type": "string", "enum": [ + "c", + "cpp", + "csharp", "go", + "java", "javascript", + "kotlin", "python", "ruby", "typescript" @@ -238594,6 +238670,634 @@ ] } ], + "protection-rules": [ + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules", + "title": "Get all deployment protection rules for an environment", + "category": "deployments", + "subcategory": "protection-rules", + "parameters": [ + { + "name": "environment_name", + "in": "path", + "required": true, + "description": "

The name of the environment.

", + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

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

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

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

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "environment_name": "ENVIRONMENT_NAME", + "repo": "REPO", + "owner": "OWNER" + } + }, + "response": { + "statusCode": "200", + "description": "

List of deployment protection rules

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

Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the repo scope. GitHub Apps and fine-grained personal access tokens must have the actions:read permission to use this endpoint. For more information about environments, see \"Using environments for deployment.\"

\n

For more information about the app that is providing this custom deployment rule, see the documentation for the GET /apps/{app_slug} endpoint.

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

List of deployment protection rules

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules", + "title": "Create a custom deployment protection rule on an environment", + "category": "deployments", + "subcategory": "protection-rules", + "parameters": [ + { + "name": "environment_name", + "in": "path", + "required": true, + "description": "

The name of the environment.

", + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

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

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

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

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

The ID of the custom app that will be enabled on the environment.

" + } + ], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "integration_id": 5 + }, + "parameters": { + "environment_name": "ENVIRONMENT_NAME", + "repo": "REPO", + "owner": "OWNER" + } + }, + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "

The enabled custom deployment protection rule

", + "example": { + "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" + } + }, + "schema": { + "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" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "

Enable a custom deployment protection rule for an environment.

\n

You must authenticate using an access token with the repo scope to use this endpoint. Enabling a custom protection rule requires admin or owner permissions to the repository. GitHub Apps must have the actions:write permission to use this endpoint.

\n

For more information about the app that is providing this custom deployment rule, see the documentation for the GET /apps/{app_slug} endpoint.

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

The enabled custom deployment protection rule

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/apps", + "title": "List custom deployment rule integrations available for an environment", + "category": "deployments", + "subcategory": "protection-rules", + "parameters": [ + { + "name": "environment_name", + "in": "path", + "required": true, + "description": "

The name of the environment.

", + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

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

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

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

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

Page number of the results to fetch.

", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "

The number of results per page (max 100).

", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "environment_name": "ENVIRONMENT_NAME", + "repo": "REPO", + "owner": "OWNER" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

A list of custom deployment rule integrations available for this environment.

", + "example": [ + { + "total_count": 2 + }, + { + "available_custom_deployment_protection_rule_integrations": [ + { + "id": 1, + "node_id": "GHT58kRlcGxveW1lbnRTdTY!bbcy", + "slug": "a-custom-app", + "integration_url": "https://api.github.com/apps/a-custom-app" + }, + { + "id": 2, + "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 total number of custom deployment protection rule integrations available for this environment.", + "type": "integer", + "examples": [ + 35 + ] + }, + "available_custom_deployment_protection_rule_integrations": { + "type": "array", + "items": { + "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" + ] + } + } + } + } + } + } + ], + "previews": [], + "descriptionHTML": "

Gets all custom deployment protection rule integrations that are available for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the repo scope. GitHub Apps and fine-grained personal access tokens must have the actions:read permission to use this endpoint.

\n

For more information about environments, see \"Using environments for deployment.\"

\n

For more information about the app that is providing this custom deployment rule, see \"GET an app\".

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

A list of custom deployment rule integrations available for this environment.

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/{protection_rule_id}", + "title": "Get a custom deployment protection rule", + "category": "deployments", + "subcategory": "protection-rules", + "parameters": [ + { + "name": "owner", + "description": "

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

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

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

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

The name of the environment.

", + "schema": { + "type": "string" + } + }, + { + "name": "protection_rule_id", + "description": "

The unique identifier of the protection rule.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "environment_name": "ENVIRONMENT_NAME", + "protection_rule_id": "PROTECTION_RULE_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "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" + } + }, + "schema": { + "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" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "

Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the repo scope. GitHub Apps and fine-grained personal access tokens must have the actions:read permission to use this endpoint. For more information about environments, see \"Using environments for deployment.\"

\n

For more information about the app that is providing this custom deployment rule, see GET /apps/{app_slug}.

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

OK

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "delete", + "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/{protection_rule_id}", + "title": "Disable a custom protection rule for an environment", + "category": "deployments", + "subcategory": "protection-rules", + "parameters": [ + { + "name": "environment_name", + "in": "path", + "required": true, + "description": "

The name of the environment.

", + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

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

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

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

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

The unique identifier of the protection rule.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "environment_name": "ENVIRONMENT_NAME", + "repo": "REPO", + "owner": "OWNER", + "protection_rule_id": "PROTECTION_RULE_ID" + } + }, + "response": { + "statusCode": "204", + "description": "

Response

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

Disables a custom deployment protection rule for an environment.

\n

You must authenticate using an access token with the repo scope to use this endpoint. Removing a custom protection rule requires admin or owner permissions to the repository. GitHub Apps must have the actions:write permission to use this endpoint. For more information, see \"Get an app\".

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

No Content

" + } + ] + } + ], "statuses": [ { "serverUrl": "https://api.github.com", @@ -345867,7 +346571,7 @@ } ], "previews": [], - "descriptionHTML": "

View the progress of an import.

\n

Import status

\n

This section includes details about the possible values of the status field of the Import Progress response.

\n

An import that does not have errors will progress through these steps:

\n\n

If there are problems, you will see one of these in the status field:

\n\n

The project_choices field

\n

When multiple projects are found at the provided URL, the response hash will include a project_choices field, the value of which is an array of hashes each representing a project choice. The exact key/value pairs of the project hashes will differ depending on the version control type.

\n

Git LFS related fields

\n

This section includes details about Git LFS related fields that may be present in the Import Progress response.

\n", + "descriptionHTML": "

View the progress of an import.

\n

Warning: Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end\non October 17, 2023. For more details, see changelog. In the coming weeks, we will update\nthese docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.

\n

Import status

\n

This section includes details about the possible values of the status field of the Import Progress response.

\n

An import that does not have errors will progress through these steps:

\n\n

If there are problems, you will see one of these in the status field:

\n\n

The project_choices field

\n

When multiple projects are found at the provided URL, the response hash will include a project_choices field, the value of which is an array of hashes each representing a project choice. The exact key/value pairs of the project hashes will differ depending on the version control type.

\n

Git LFS related fields

\n

This section includes details about Git LFS related fields that may be present in the Import Progress response.

\n", "statusCodes": [ { "httpStatusCode": "200", @@ -346138,7 +346842,7 @@ } ], "previews": [], - "descriptionHTML": "

Start a source import to a GitHub repository using GitHub Importer. Importing into a GitHub repository with GitHub Actions enabled is not supported and will return a status 422 Unprocessable Entity response.

", + "descriptionHTML": "

Start a source import to a GitHub repository using GitHub Importer. Importing into a GitHub repository with GitHub Actions enabled is not supported and will return a status 422 Unprocessable Entity response.\nWarning: Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end on October 17, 2023. For more details, see changelog. In the coming weeks, we will update these docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.

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

An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API\nrequest. If no parameters are provided, the import will be restarted.

\n

Some servers (e.g. TFS servers) can have several projects at a single URL. In those cases the import progress will\nhave the status detection_found_multiple and the Import Progress response will include a project_choices array.\nYou can select the project to import by providing one of the objects in the project_choices array in the update request.

", + "descriptionHTML": "

An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API\nrequest. If no parameters are provided, the import will be restarted.

\n

Some servers (e.g. TFS servers) can have several projects at a single URL. In those cases the import progress will\nhave the status detection_found_multiple and the Import Progress response will include a project_choices array.\nYou can select the project to import by providing one of the objects in the project_choices array in the update request.

\n

Warning: Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end\non October 17, 2023. For more details, see changelog. In the coming weeks, we will update\nthese docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.

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

Stop an import for a repository.

", + "descriptionHTML": "

Stop an import for a repository.

\n

Warning: Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end\non October 17, 2023. For more details, see changelog. In the coming weeks, we will update\nthese docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.

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

Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username hubot into something like hubot <hubot@12341234-abab-fefe-8787-fedcba987654>.

\n

This endpoint and the Map a commit author endpoint allow you to provide correct Git author information.

", + "descriptionHTML": "

Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username hubot into something like hubot <hubot@12341234-abab-fefe-8787-fedcba987654>.

\n

This endpoint and the Map a commit author endpoint allow you to provide correct Git author information.

\n

Warning: Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end\non October 17, 2023. For more details, see changelog. In the coming weeks, we will update\nthese docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.

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

Update an author's identity for the import. Your application can continue updating authors any time before you push new commits to the repository.

", + "descriptionHTML": "

Update an author's identity for the import. Your application can continue updating authors any time before you push\nnew commits to the repository.

\n

Warning: Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end\non October 17, 2023. For more details, see changelog. In the coming weeks, we will update\nthese docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.

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

List files larger than 100MB found during the import

", + "descriptionHTML": "

List files larger than 100MB found during the import

\n

Warning: Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end\non October 17, 2023. For more details, see changelog. In the coming weeks, we will update\nthese docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.

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

You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability is powered by Git LFS. You can learn more about our LFS feature and working with large files on our help site.

", + "descriptionHTML": "

You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability\nis powered by Git LFS.

\n

You can learn more about our LFS feature and working with large files on our help\nsite.

\n

Warning: Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end\non October 17, 2023. For more details, see changelog. In the coming weeks, we will update\nthese docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.

", "statusCodes": [ { "httpStatusCode": "200", @@ -504032,545 +504736,1817 @@ "type", "url" ] - } - ], - "type": [ - "null" - ] - }, - "identifiers": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type of identifier.", - "enum": [ - "CVE", - "GHSA" - ] - }, - "value": { - "type": "string", - "description": "The identifier value." - } + } + ], + "type": [ + "null" + ] + }, + "identifiers": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of identifier.", + "enum": [ + "CVE", + "GHSA" + ] + }, + "value": { + "type": "string", + "description": "The identifier value." + } + }, + "required": [ + "type", + "value" + ] + }, + "readOnly": true + }, + "state": { + "type": "string", + "description": "The state of the advisory.", + "enum": [ + "published", + "closed", + "withdrawn", + "draft", + "triage" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The date and time of when the advisory was created, in ISO 8601 format.", + "readOnly": true + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The date and time of when the advisory was last updated, in ISO 8601 format.", + "readOnly": true + }, + "published_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The date and time of when the advisory was published, in ISO 8601 format.", + "readOnly": true + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The date and time of when the advisory was closed, in ISO 8601 format.", + "readOnly": true + }, + "withdrawn_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The date and time of when the advisory was withdrawn, in ISO 8601 format.", + "readOnly": true + }, + "submission": { + "type": [ + "object", + "null" + ], + "readOnly": true, + "properties": { + "accepted": { + "type": "boolean", + "description": "Whether a private vulnerability report was accepted by the repository's administrators.", + "readOnly": true + } + }, + "required": [ + "accepted" + ] + }, + "vulnerabilities": { + "type": [ + "array", + "null" + ], + "items": { + "description": "A product affected by the vulnerability detailed in a repository security advisory.", + "type": "object", + "properties": { + "package": { + "description": "The name of the package affected by the vulnerability.", + "type": [ + "object", + "null" + ], + "properties": { + "ecosystem": { + "type": "string", + "description": "The package's language or package management ecosystem.", + "enum": [ + "rubygems", + "npm", + "pip", + "maven", + "nuget", + "composer", + "go", + "rust", + "erlang", + "actions", + "pub", + "other" + ] + }, + "name": { + "type": [ + "string", + "null" + ], + "description": "The unique package name within its ecosystem." + } + }, + "required": [ + "ecosystem", + "name" + ] + }, + "vulnerable_version_range": { + "type": [ + "string", + "null" + ], + "description": "The range of the package versions affected by the vulnerability." + }, + "patched_versions": { + "type": [ + "string", + "null" + ], + "description": "The package version(s) that resolve the vulnerability." + }, + "vulnerable_functions": { + "type": [ + "array", + "null" + ], + "description": "The functions in the package that are affected.", + "items": { + "type": "string" + } + } + }, + "required": [ + "package", + "vulnerable_version_range", + "patched_versions", + "vulnerable_functions" + ], + "additionalProperties": false + } + }, + "cvss": { + "type": [ + "object", + "null" + ], + "properties": { + "vector_string": { + "type": [ + "string", + "null" + ], + "description": "The CVSS vector." + }, + "score": { + "type": [ + "number", + "null" + ], + "description": "The CVSS score.", + "minimum": 0, + "maximum": 10, + "readOnly": true + } + }, + "required": [ + "vector_string", + "score" + ] + }, + "cwes": { + "type": [ + "array", + "null" + ], + "items": { + "type": "object", + "properties": { + "cwe_id": { + "type": "string", + "description": "The Common Weakness Enumeration (CWE) identifier." + }, + "name": { + "type": "string", + "description": "The name of the CWE.", + "readOnly": true + } + }, + "required": [ + "cwe_id", + "name" + ] + }, + "readOnly": true + }, + "cwe_ids": { + "type": [ + "array", + "null" + ], + "description": "A list of only the CWE IDs.", + "items": { + "type": "string" + } + }, + "credits": { + "type": [ + "array", + "null" + ], + "items": { + "type": "object", + "properties": { + "login": { + "type": "string", + "description": "The username of the user credited." + }, + "type": { + "type": "string", + "description": "The type of credit the user is receiving.", + "enum": [ + "analyst", + "finder", + "reporter", + "coordinator", + "remediation_developer", + "remediation_reviewer", + "remediation_verifier", + "tool", + "sponsor", + "other" + ] + } + } + } + }, + "credits_detailed": { + "type": [ + "array", + "null" + ], + "items": { + "description": "A credit given to a user for a repository security advisory.", + "type": "object", + "properties": { + "user": { + "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" + ] + }, + "type": { + "type": "string", + "description": "The type of credit the user is receiving.", + "enum": [ + "analyst", + "finder", + "reporter", + "coordinator", + "remediation_developer", + "remediation_reviewer", + "remediation_verifier", + "tool", + "sponsor", + "other" + ] + }, + "state": { + "type": "string", + "description": "The state of the user's acceptance of the credit.", + "enum": [ + "accepted", + "declined", + "pending" + ] + } + }, + "required": [ + "user", + "type", + "state" + ], + "additionalProperties": false + }, + "readOnly": true + } + }, + "required": [ + "ghsa_id", + "cve_id", + "url", + "html_url", + "summary", + "description", + "severity", + "author", + "publisher", + "identifiers", + "state", + "created_at", + "updated_at", + "published_at", + "closed_at", + "withdrawn_at", + "submission", + "vulnerabilities", + "cvss", + "cwes", + "cwe_ids", + "credits", + "credits_detailed" + ], + "additionalProperties": false + } + } + } + } + ], + "previews": [], + "descriptionHTML": "

Lists security advisories in a repository.\nYou must authenticate using an access token with the repo scope or repository_advisories:read permission\nin order to get published security advisories in a private repository, or any unpublished security advisories that you have access to.

\n

You can access unpublished security advisories from a repository if you are a security manager or administrator of that repository, or if you are a collaborator on any security advisory.

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

OK

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

Bad Request

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

Resource not found

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/security-advisories", + "title": "Create a repository security advisory", + "category": "security-advisories", + "subcategory": "repository-advisories", + "parameters": [ + { + "name": "owner", + "description": "

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

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

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

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

A short summary of the advisory.

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

A detailed description of what the advisory impacts.

", + "isRequired": true + }, + { + "type": "string or null", + "name": "cve_id", + "in": "body", + "description": "

The Common Vulnerabilities and Exposures (CVE) ID.

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

A product affected by the vulnerability detailed in a repository security advisory.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "package", + "description": "

The name of the package affected by the vulnerability.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ecosystem", + "description": "

The package's language or package management ecosystem.

", + "isRequired": true, + "enum": [ + "rubygems", + "npm", + "pip", + "maven", + "nuget", + "composer", + "go", + "rust", + "erlang", + "actions", + "pub", + "other" + ] + }, + { + "type": "string or null", + "name": "name", + "description": "

The unique package name within its ecosystem.

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

The range of the package versions affected by the vulnerability.

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

The package version(s) that resolve the vulnerability.

" + }, + { + "type": "array of strings or null", + "name": "vulnerable_functions", + "description": "

The functions in the package that are affected.

" + } + ] + }, + { + "type": "array of strings or null", + "name": "cwe_ids", + "in": "body", + "description": "

A list of Common Weakness Enumeration (CWE) IDs.

" + }, + { + "type": "array of objects or null", + "name": "credits", + "in": "body", + "description": "

A list of users receiving credit for their participation in the security advisory.

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

The username of the user credited.

", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "

The type of credit the user is receiving.

", + "isRequired": true, + "enum": [ + "analyst", + "finder", + "reporter", + "coordinator", + "remediation_developer", + "remediation_reviewer", + "remediation_verifier", + "tool", + "sponsor", + "other" + ] + } + ] + }, + { + "type": "string or null", + "name": "severity", + "in": "body", + "description": "

The severity of the advisory. You must choose between setting this field or cvss_vector_string.

", + "enum": [ + "critical", + "high", + "medium", + "low", + null + ] + }, + { + "type": "string or null", + "name": "cvss_vector_string", + "in": "body", + "description": "

The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or severity.

" + } + ], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "summary": "A new important advisory", + "description": "A more in-depth description of what the problem is.", + "severity": "high", + "cve_id": null, + "vulnerabilities": [ + { + "package": { + "name": "a-package", + "ecosystem": "npm" + }, + "vulnerable_version_range": "< 1.0.0", + "patched_versions": "1.0.0", + "vulnerable_functions": [ + "important_function" + ] + } + ], + "cwe_ids": [ + "CWE-1101", + "CWE-20" + ], + "credits": [ + { + "login": "monalisa", + "type": "reporter" + }, + { + "login": "octocat", + "type": "analyst" + } + ] + }, + "parameters": { + "owner": "OWNER", + "repo": "REPO" + } + }, + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "

Response

", + "example": { + "ghsa_id": "GHSA-abcd-1234-efgh", + "cve_id": "CVE-2050-00000", + "url": "https://api.github.com/repos/repo/a-package/security-advisories/GHSA-abcd-1234-efgh", + "html_url": "https://github.com/repo/a-package/security/advisories/GHSA-abcd-1234-efgh", + "summary": "A short summary of the advisory.", + "description": "A detailed description of what the advisory entails.", + "severity": "critical", + "author": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "publisher": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "identifiers": [ + { + "type": "GHSA", + "value": "GHSA-abcd-1234-efgh" + }, + { + "type": "CVE", + "value": "CVE-2050-00000" + } + ], + "state": "published", + "created_at": "2020-01-01T00:00:00Z", + "updated_at": "2020-01-02T00:00:00Z", + "published_at": "2020-01-03T00:00:00Z", + "closed_at": null, + "withdrawn_at": null, + "submission": null, + "vulnerabilities": [ + { + "package": { + "ecosystem": "pip", + "name": "a-package" + }, + "vulnerable_version_range": ">= 1.0.0, < 1.0.1", + "patched_versions": "1.0.1", + "vulnerable_functions": [ + "function1" + ] + }, + { + "package": { + "ecosystem": "pip", + "name": "another-package" + }, + "vulnerable_version_range": ">= 1.0.0, < 1.0.2", + "patched_versions": "1.0.2", + "vulnerable_functions": [ + "function2" + ] + } + ], + "cvss": { + "vector_string": "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H", + "score": 9.8 + }, + "cwes": [ + { + "cwe_id": "CWE-123", + "name": "A CWE" + } + ], + "cwe_ids": [ + "CWE-123" + ], + "credits": [ + { + "login": "octocat", + "type": "analyst" + } + ], + "credits_detailed": [ + { + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "type": "analyst", + "state": "accepted" + } + ] + }, + "schema": { + "description": "A repository security advisory.", + "type": "object", + "properties": { + "ghsa_id": { + "type": "string", + "description": "The GitHub Security Advisory ID.", + "readOnly": true + }, + "cve_id": { + "type": [ + "string", + "null" + ], + "description": "The Common Vulnerabilities and Exposures (CVE) ID." + }, + "url": { + "type": "string", + "description": "The API URL for the advisory." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL for the advisory.", + "readOnly": true + }, + "summary": { + "type": "string", + "description": "A short summary of the advisory.", + "maxLength": 1024 + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "A detailed description of what the advisory entails.", + "maxLength": 65535 + }, + "severity": { + "type": [ + "string", + "null" + ], + "description": "The severity of the advisory.", + "enum": [ + "critical", + "high", + "medium", + "low", + null + ] + }, + "author": { + "readOnly": true, + "description": "The author of the advisory.", + "allOf": [ + { + "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" + ] + } + ], + "type": [ + "null" + ] + }, + "publisher": { + "readOnly": true, + "description": "The publisher of the advisory.", + "allOf": [ + { + "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" + ] + } + ], + "type": [ + "null" + ] + }, + "identifiers": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of identifier.", + "enum": [ + "CVE", + "GHSA" + ] + }, + "value": { + "type": "string", + "description": "The identifier value." + } + }, + "required": [ + "type", + "value" + ] + }, + "readOnly": true + }, + "state": { + "type": "string", + "description": "The state of the advisory.", + "enum": [ + "published", + "closed", + "withdrawn", + "draft", + "triage" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The date and time of when the advisory was created, in ISO 8601 format.", + "readOnly": true + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The date and time of when the advisory was last updated, in ISO 8601 format.", + "readOnly": true + }, + "published_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The date and time of when the advisory was published, in ISO 8601 format.", + "readOnly": true + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The date and time of when the advisory was closed, in ISO 8601 format.", + "readOnly": true + }, + "withdrawn_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The date and time of when the advisory was withdrawn, in ISO 8601 format.", + "readOnly": true + }, + "submission": { + "type": [ + "object", + "null" + ], + "readOnly": true, + "properties": { + "accepted": { + "type": "boolean", + "description": "Whether a private vulnerability report was accepted by the repository's administrators.", + "readOnly": true + } + }, + "required": [ + "accepted" + ] + }, + "vulnerabilities": { + "type": [ + "array", + "null" + ], + "items": { + "description": "A product affected by the vulnerability detailed in a repository security advisory.", + "type": "object", + "properties": { + "package": { + "description": "The name of the package affected by the vulnerability.", + "type": [ + "object", + "null" + ], + "properties": { + "ecosystem": { + "type": "string", + "description": "The package's language or package management ecosystem.", + "enum": [ + "rubygems", + "npm", + "pip", + "maven", + "nuget", + "composer", + "go", + "rust", + "erlang", + "actions", + "pub", + "other" + ] + }, + "name": { + "type": [ + "string", + "null" + ], + "description": "The unique package name within its ecosystem." + } + }, + "required": [ + "ecosystem", + "name" + ] + }, + "vulnerable_version_range": { + "type": [ + "string", + "null" + ], + "description": "The range of the package versions affected by the vulnerability." + }, + "patched_versions": { + "type": [ + "string", + "null" + ], + "description": "The package version(s) that resolve the vulnerability." + }, + "vulnerable_functions": { + "type": [ + "array", + "null" + ], + "description": "The functions in the package that are affected.", + "items": { + "type": "string" + } + } + }, + "required": [ + "package", + "vulnerable_version_range", + "patched_versions", + "vulnerable_functions" + ], + "additionalProperties": false + } + }, + "cvss": { + "type": [ + "object", + "null" + ], + "properties": { + "vector_string": { + "type": [ + "string", + "null" + ], + "description": "The CVSS vector." + }, + "score": { + "type": [ + "number", + "null" + ], + "description": "The CVSS score.", + "minimum": 0, + "maximum": 10, + "readOnly": true + } + }, + "required": [ + "vector_string", + "score" + ] + }, + "cwes": { + "type": [ + "array", + "null" + ], + "items": { + "type": "object", + "properties": { + "cwe_id": { + "type": "string", + "description": "The Common Weakness Enumeration (CWE) identifier." + }, + "name": { + "type": "string", + "description": "The name of the CWE.", + "readOnly": true + } + }, + "required": [ + "cwe_id", + "name" + ] + }, + "readOnly": true + }, + "cwe_ids": { + "type": [ + "array", + "null" + ], + "description": "A list of only the CWE IDs.", + "items": { + "type": "string" + } + }, + "credits": { + "type": [ + "array", + "null" + ], + "items": { + "type": "object", + "properties": { + "login": { + "type": "string", + "description": "The username of the user credited." + }, + "type": { + "type": "string", + "description": "The type of credit the user is receiving.", + "enum": [ + "analyst", + "finder", + "reporter", + "coordinator", + "remediation_developer", + "remediation_reviewer", + "remediation_verifier", + "tool", + "sponsor", + "other" + ] + } + } + } + }, + "credits_detailed": { + "type": [ + "array", + "null" + ], + "items": { + "description": "A credit given to a user for a repository security advisory.", + "type": "object", + "properties": { + "user": { + "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" + ] }, - "required": [ - "type", - "value" - ] - }, - "readOnly": true - }, - "state": { - "type": "string", - "description": "The state of the advisory.", - "enum": [ - "published", - "closed", - "withdrawn", - "draft", - "triage" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The date and time of when the advisory was created, in ISO 8601 format.", - "readOnly": true - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The date and time of when the advisory was last updated, in ISO 8601 format.", - "readOnly": true - }, - "published_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The date and time of when the advisory was published, in ISO 8601 format.", - "readOnly": true - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The date and time of when the advisory was closed, in ISO 8601 format.", - "readOnly": true - }, - "withdrawn_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The date and time of when the advisory was withdrawn, in ISO 8601 format.", - "readOnly": true - }, - "submission": { - "type": [ - "object", - "null" - ], - "readOnly": true, - "properties": { - "accepted": { - "type": "boolean", - "description": "Whether a private vulnerability report was accepted by the repository's administrators.", - "readOnly": true - } - }, - "required": [ - "accepted" - ] - }, - "vulnerabilities": { - "type": [ - "array", - "null" - ], - "items": { - "description": "A product affected by the vulnerability detailed in a repository security advisory.", - "type": "object", - "properties": { - "package": { - "description": "The name of the package affected by the vulnerability.", - "type": [ - "object", - "null" - ], - "properties": { - "ecosystem": { - "type": "string", - "description": "The package's language or package management ecosystem.", - "enum": [ - "rubygems", - "npm", - "pip", - "maven", - "nuget", - "composer", - "go", - "rust", - "erlang", - "actions", - "pub", - "other" - ] - }, - "name": { - "type": [ - "string", - "null" - ], - "description": "The unique package name within its ecosystem." - } - }, - "required": [ - "ecosystem", - "name" - ] - }, - "vulnerable_version_range": { - "type": [ - "string", - "null" - ], - "description": "The range of the package versions affected by the vulnerability." - }, - "patched_versions": { - "type": [ - "string", - "null" - ], - "description": "The package version(s) that resolve the vulnerability." - }, - "vulnerable_functions": { - "type": [ - "array", - "null" - ], - "description": "The functions in the package that are affected.", - "items": { - "type": "string" - } - } - }, - "required": [ - "package", - "vulnerable_version_range", - "patched_versions", - "vulnerable_functions" - ], - "additionalProperties": false - } - }, - "cvss": { - "type": [ - "object", - "null" - ], - "properties": { - "vector_string": { - "type": [ - "string", - "null" - ], - "description": "The CVSS vector." + "type": { + "type": "string", + "description": "The type of credit the user is receiving.", + "enum": [ + "analyst", + "finder", + "reporter", + "coordinator", + "remediation_developer", + "remediation_reviewer", + "remediation_verifier", + "tool", + "sponsor", + "other" + ] }, - "score": { - "type": [ - "number", - "null" - ], - "description": "The CVSS score.", - "minimum": 0, - "maximum": 10, - "readOnly": true + "state": { + "type": "string", + "description": "The state of the user's acceptance of the credit.", + "enum": [ + "accepted", + "declined", + "pending" + ] } }, "required": [ - "vector_string", - "score" - ] - }, - "cwes": { - "type": [ - "array", - "null" - ], - "items": { - "type": "object", - "properties": { - "cwe_id": { - "type": "string", - "description": "The Common Weakness Enumeration (CWE) identifier." - }, - "name": { - "type": "string", - "description": "The name of the CWE.", - "readOnly": true - } - }, - "required": [ - "cwe_id", - "name" - ] - }, - "readOnly": true - }, - "cwe_ids": { - "type": [ - "array", - "null" - ], - "description": "A list of only the CWE IDs.", - "items": { - "type": "string" - } - }, - "credits": { - "type": [ - "array", - "null" + "user", + "type", + "state" ], - "items": { - "type": "object", - "properties": { - "login": { - "type": "string", - "description": "The username of the user credited." - }, - "type": { - "type": "string", - "description": "The type of credit the user is receiving.", - "enum": [ - "analyst", - "finder", - "reporter", - "coordinator", - "remediation_developer", - "remediation_reviewer", - "remediation_verifier", - "tool", - "sponsor", - "other" - ] - } - } - } + "additionalProperties": false }, - "credits_detailed": { - "type": [ - "array", - "null" - ], - "items": { - "description": "A credit given to a user for a repository security advisory.", - "type": "object", - "properties": { - "user": { - "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" - ] - }, - "type": { - "type": "string", - "description": "The type of credit the user is receiving.", - "enum": [ - "analyst", - "finder", - "reporter", - "coordinator", - "remediation_developer", - "remediation_reviewer", - "remediation_verifier", - "tool", - "sponsor", - "other" - ] - }, - "state": { - "type": "string", - "description": "The state of the user's acceptance of the credit.", - "enum": [ - "accepted", - "declined", - "pending" - ] - } - }, - "required": [ - "user", - "type", - "state" - ], - "additionalProperties": false - }, - "readOnly": true - } - }, - "required": [ - "ghsa_id", - "cve_id", - "url", - "html_url", - "summary", - "description", - "severity", - "author", - "publisher", - "identifiers", - "state", - "created_at", - "updated_at", - "published_at", - "closed_at", - "withdrawn_at", - "submission", - "vulnerabilities", - "cvss", - "cwes", - "cwe_ids", - "credits", - "credits_detailed" - ], - "additionalProperties": false - } + "readOnly": true + } + }, + "required": [ + "ghsa_id", + "cve_id", + "url", + "html_url", + "summary", + "description", + "severity", + "author", + "publisher", + "identifiers", + "state", + "created_at", + "updated_at", + "published_at", + "closed_at", + "withdrawn_at", + "submission", + "vulnerabilities", + "cvss", + "cwes", + "cwe_ids", + "credits", + "credits_detailed" + ], + "additionalProperties": false } } } ], "previews": [], - "descriptionHTML": "

Lists security advisories in a repository.\nYou must authenticate using an access token with the repo scope or repository_advisories:read permission\nin order to get published security advisories in a private repository, or any unpublished security advisories that you have access to.

\n

You can access unpublished security advisories from a repository if you are a security manager or administrator of that repository, or if you are a collaborator on any security advisory.

", + "descriptionHTML": "

Creates a new repository security advisory.\nYou must authenticate using an access token with the repo scope or repository_advisories:write permission to use this endpoint.

\n

In order to create a draft repository security advisory, you must be a security manager or administrator of that repository.

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

OK

" + "httpStatusCode": "201", + "description": "

Created

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

Bad Request

" + "httpStatusCode": "403", + "description": "

Forbidden

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

Resource not found

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

Validation failed, or the endpoint has been spammed.

" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", - "requestPath": "/repos/{owner}/{repo}/security-advisories", - "title": "Create a repository security advisory", + "requestPath": "/repos/{owner}/{repo}/security-advisories/reports", + "title": "Privately report a security vulnerability", "category": "security-advisories", "subcategory": "repository-advisories", "parameters": [ @@ -504609,17 +506585,10 @@ "isRequired": true }, { - "type": "string or null", - "name": "cve_id", - "in": "body", - "description": "

The Common Vulnerabilities and Exposures (CVE) ID.

" - }, - { - "type": "array of objects", + "type": "array of objects or null", "name": "vulnerabilities", "in": "body", - "description": "

A product affected by the vulnerability detailed in a repository security advisory.

", - "isRequired": true, + "description": "

An array of products affected by the vulnerability detailed in a repository security advisory.

", "childParamsGroups": [ { "type": "object", @@ -504677,38 +506646,6 @@ "in": "body", "description": "

A list of Common Weakness Enumeration (CWE) IDs.

" }, - { - "type": "array of objects or null", - "name": "credits", - "in": "body", - "description": "

A list of users receiving credit for their participation in the security advisory.

", - "childParamsGroups": [ - { - "type": "string", - "name": "login", - "description": "

The username of the user credited.

", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "

The type of credit the user is receiving.

", - "isRequired": true, - "enum": [ - "analyst", - "finder", - "reporter", - "coordinator", - "remediation_developer", - "remediation_reviewer", - "remediation_verifier", - "tool", - "sponsor", - "other" - ] - } - ] - }, { "type": "string or null", "name": "severity", @@ -504738,10 +506675,9 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "summary": "A new important advisory", + "summary": "A newly discovered vulnerability", "description": "A more in-depth description of what the problem is.", "severity": "high", - "cve_id": null, "vulnerabilities": [ { "package": { @@ -504756,18 +506692,7 @@ } ], "cwe_ids": [ - "CWE-1101", - "CWE-20" - ], - "credits": [ - { - "login": "monalisa", - "type": "reporter" - }, - { - "login": "octocat", - "type": "analyst" - } + "CWE-123" ] }, "parameters": { @@ -504784,9 +506709,9 @@ "cve_id": "CVE-2050-00000", "url": "https://api.github.com/repos/repo/a-package/security-advisories/GHSA-abcd-1234-efgh", "html_url": "https://github.com/repo/a-package/security/advisories/GHSA-abcd-1234-efgh", - "summary": "A short summary of the advisory.", - "description": "A detailed description of what the advisory entails.", - "severity": "critical", + "summary": "A newly discovered vulnerability", + "description": "A more in-depth description of what the problem is.", + "severity": "high", "author": { "login": "octocat", "id": 1, @@ -504807,26 +506732,7 @@ "type": "User", "site_admin": false }, - "publisher": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, + "publisher": null, "identifiers": [ { "type": "GHSA", @@ -504834,44 +506740,32 @@ }, { "type": "CVE", - "value": "CVE-2050-00000" + "value": null } ], - "state": "published", + "state": "triage", "created_at": "2020-01-01T00:00:00Z", "updated_at": "2020-01-02T00:00:00Z", - "published_at": "2020-01-03T00:00:00Z", + "published_at": null, "closed_at": null, "withdrawn_at": null, - "submission": null, + "submission": { + "accepted": false + }, "vulnerabilities": [ { "package": { - "ecosystem": "pip", + "ecosystem": "npm", "name": "a-package" }, - "vulnerable_version_range": ">= 1.0.0, < 1.0.1", - "patched_versions": "1.0.1", - "vulnerable_functions": [ - "function1" - ] - }, - { - "package": { - "ecosystem": "pip", - "name": "another-package" - }, - "vulnerable_version_range": ">= 1.0.0, < 1.0.2", - "patched_versions": "1.0.2", + "vulnerable_version_range": "< 1.0.0", + "patched_versions": "1.0.0", "vulnerable_functions": [ - "function2" + "important_function" ] } ], - "cvss": { - "vector_string": "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H", - "score": 9.8 - }, + "cvss": null, "cwes": [ { "cwe_id": "CWE-123", @@ -504884,7 +506778,7 @@ "credits": [ { "login": "octocat", - "type": "analyst" + "type": "finder" } ], "credits_detailed": [ @@ -504909,7 +506803,7 @@ "type": "User", "site_admin": false }, - "type": "analyst", + "type": "finder", "state": "accepted" } ] @@ -505818,7 +507712,7 @@ } ], "previews": [], - "descriptionHTML": "

Creates a new repository security advisory.\nYou must authenticate using an access token with the repo scope or repository_advisories:write permission to use this endpoint.

\n

In order to create a draft repository security advisory, you must be a security manager or administrator of that repository.

", + "descriptionHTML": "

Report a security vulnerability to the maintainers of the repository.\nSee \"Privately reporting a security vulnerability\" for more information about private vulnerability reporting.

", "statusCodes": [ { "httpStatusCode": "201", diff --git a/src/rest/data/ghae/schema.json b/src/rest/data/ghae/schema.json index 4540af713318..fb8d5b006126 100644 --- a/src/rest/data/ghae/schema.json +++ b/src/rest/data/ghae/schema.json @@ -36365,8 +36365,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

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

", "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 72a91b36964a..981c4ccd98a8 100644 --- a/src/rest/data/ghec-2022-11-28/schema.json +++ b/src/rest/data/ghec-2022-11-28/schema.json @@ -50259,6 +50259,77 @@ } ] }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/deployment_protection_rule", + "title": "Review custom deployment protection rules for a workflow run", + "category": "actions", + "subcategory": "workflow-runs", + "parameters": [ + { + "name": "owner", + "description": "

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

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

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

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

The unique identifier of the workflow run.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "environment_name": "prod-eus", + "state": "approved", + "comment": "All health checks passed." + }, + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "run_id": "RUN_ID" + } + }, + "response": { + "statusCode": "204", + "description": "

Response

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

Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see \"Using environments for deployment.\"

\n

Note: GitHub Apps can only review their own custom deployment protection rules.\nTo approve or reject pending deployments that are waiting for review from a specific person or team, see POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments.

\n

GitHub Apps must have read and write permission for Deployments to use this endpoint.

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

No Content

" + } + ] + }, { "serverUrl": "https://api.github.com", "verb": "get", @@ -71855,8 +71926,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

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

", "statusCodes": [ { "httpStatusCode": "200", @@ -173919,8 +173990,13 @@ "items": { "type": "string", "enum": [ + "c", + "cpp", + "csharp", "go", + "java", "javascript", + "kotlin", "python", "ruby", "typescript" @@ -250059,6 +250135,634 @@ ] } ], + "protection-rules": [ + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules", + "title": "Get all deployment protection rules for an environment", + "category": "deployments", + "subcategory": "protection-rules", + "parameters": [ + { + "name": "environment_name", + "in": "path", + "required": true, + "description": "

The name of the environment.

", + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

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

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

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

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "environment_name": "ENVIRONMENT_NAME", + "repo": "REPO", + "owner": "OWNER" + } + }, + "response": { + "statusCode": "200", + "description": "

List of deployment protection rules

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

Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the repo scope. GitHub Apps and fine-grained personal access tokens must have the actions:read permission to use this endpoint. For more information about environments, see \"Using environments for deployment.\"

\n

For more information about the app that is providing this custom deployment rule, see the documentation for the GET /apps/{app_slug} endpoint.

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

List of deployment protection rules

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules", + "title": "Create a custom deployment protection rule on an environment", + "category": "deployments", + "subcategory": "protection-rules", + "parameters": [ + { + "name": "environment_name", + "in": "path", + "required": true, + "description": "

The name of the environment.

", + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

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

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

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

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

The ID of the custom app that will be enabled on the environment.

" + } + ], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "integration_id": 5 + }, + "parameters": { + "environment_name": "ENVIRONMENT_NAME", + "repo": "REPO", + "owner": "OWNER" + } + }, + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "

The enabled custom deployment protection rule

", + "example": { + "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" + } + }, + "schema": { + "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" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "

Enable a custom deployment protection rule for an environment.

\n

You must authenticate using an access token with the repo scope to use this endpoint. Enabling a custom protection rule requires admin or owner permissions to the repository. GitHub Apps must have the actions:write permission to use this endpoint.

\n

For more information about the app that is providing this custom deployment rule, see the documentation for the GET /apps/{app_slug} endpoint.

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

The enabled custom deployment protection rule

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/apps", + "title": "List custom deployment rule integrations available for an environment", + "category": "deployments", + "subcategory": "protection-rules", + "parameters": [ + { + "name": "environment_name", + "in": "path", + "required": true, + "description": "

The name of the environment.

", + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

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

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

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

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

Page number of the results to fetch.

", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "

The number of results per page (max 100).

", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "environment_name": "ENVIRONMENT_NAME", + "repo": "REPO", + "owner": "OWNER" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

A list of custom deployment rule integrations available for this environment.

", + "example": [ + { + "total_count": 2 + }, + { + "available_custom_deployment_protection_rule_integrations": [ + { + "id": 1, + "node_id": "GHT58kRlcGxveW1lbnRTdTY!bbcy", + "slug": "a-custom-app", + "integration_url": "https://api.github.com/apps/a-custom-app" + }, + { + "id": 2, + "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 total number of custom deployment protection rule integrations available for this environment.", + "type": "integer", + "examples": [ + 35 + ] + }, + "available_custom_deployment_protection_rule_integrations": { + "type": "array", + "items": { + "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" + ] + } + } + } + } + } + } + ], + "previews": [], + "descriptionHTML": "

Gets all custom deployment protection rule integrations that are available for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the repo scope. GitHub Apps and fine-grained personal access tokens must have the actions:read permission to use this endpoint.

\n

For more information about environments, see \"Using environments for deployment.\"

\n

For more information about the app that is providing this custom deployment rule, see \"GET an app\".

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

A list of custom deployment rule integrations available for this environment.

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/{protection_rule_id}", + "title": "Get a custom deployment protection rule", + "category": "deployments", + "subcategory": "protection-rules", + "parameters": [ + { + "name": "owner", + "description": "

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

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

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

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

The name of the environment.

", + "schema": { + "type": "string" + } + }, + { + "name": "protection_rule_id", + "description": "

The unique identifier of the protection rule.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "environment_name": "ENVIRONMENT_NAME", + "protection_rule_id": "PROTECTION_RULE_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "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" + } + }, + "schema": { + "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" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "

Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the repo scope. GitHub Apps and fine-grained personal access tokens must have the actions:read permission to use this endpoint. For more information about environments, see \"Using environments for deployment.\"

\n

For more information about the app that is providing this custom deployment rule, see GET /apps/{app_slug}.

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

OK

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "delete", + "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/{protection_rule_id}", + "title": "Disable a custom protection rule for an environment", + "category": "deployments", + "subcategory": "protection-rules", + "parameters": [ + { + "name": "environment_name", + "in": "path", + "required": true, + "description": "

The name of the environment.

", + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

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

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

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

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

The unique identifier of the protection rule.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "environment_name": "ENVIRONMENT_NAME", + "repo": "REPO", + "owner": "OWNER", + "protection_rule_id": "PROTECTION_RULE_ID" + } + }, + "response": { + "statusCode": "204", + "description": "

Response

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

Disables a custom deployment protection rule for an environment.

\n

You must authenticate using an access token with the repo scope to use this endpoint. Removing a custom protection rule requires admin or owner permissions to the repository. GitHub Apps must have the actions:write permission to use this endpoint. For more information, see \"Get an app\".

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

No Content

" + } + ] + } + ], "statuses": [ { "serverUrl": "https://api.github.com", @@ -359084,7 +359788,7 @@ } ], "previews": [], - "descriptionHTML": "

View the progress of an import.

\n

Import status

\n

This section includes details about the possible values of the status field of the Import Progress response.

\n

An import that does not have errors will progress through these steps:

\n\n

If there are problems, you will see one of these in the status field:

\n\n

The project_choices field

\n

When multiple projects are found at the provided URL, the response hash will include a project_choices field, the value of which is an array of hashes each representing a project choice. The exact key/value pairs of the project hashes will differ depending on the version control type.

\n

Git LFS related fields

\n

This section includes details about Git LFS related fields that may be present in the Import Progress response.

\n", + "descriptionHTML": "

View the progress of an import.

\n

Warning: Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end\non October 17, 2023. For more details, see changelog. In the coming weeks, we will update\nthese docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.

\n

Import status

\n

This section includes details about the possible values of the status field of the Import Progress response.

\n

An import that does not have errors will progress through these steps:

\n\n

If there are problems, you will see one of these in the status field:

\n\n

The project_choices field

\n

When multiple projects are found at the provided URL, the response hash will include a project_choices field, the value of which is an array of hashes each representing a project choice. The exact key/value pairs of the project hashes will differ depending on the version control type.

\n

Git LFS related fields

\n

This section includes details about Git LFS related fields that may be present in the Import Progress response.

\n", "statusCodes": [ { "httpStatusCode": "200", @@ -359355,7 +360059,7 @@ } ], "previews": [], - "descriptionHTML": "

Start a source import to a GitHub Enterprise Cloud repository using GitHub Enterprise Cloud Importer. Importing into a GitHub Enterprise Cloud repository with GitHub Actions enabled is not supported and will return a status 422 Unprocessable Entity response.

", + "descriptionHTML": "

Start a source import to a GitHub Enterprise Cloud repository using GitHub Enterprise Cloud Importer. Importing into a GitHub Enterprise Cloud repository with GitHub Actions enabled is not supported and will return a status 422 Unprocessable Entity response.\nWarning: Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end on October 17, 2023. For more details, see changelog. In the coming weeks, we will update these docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.

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

An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API\nrequest. If no parameters are provided, the import will be restarted.

\n

Some servers (e.g. TFS servers) can have several projects at a single URL. In those cases the import progress will\nhave the status detection_found_multiple and the Import Progress response will include a project_choices array.\nYou can select the project to import by providing one of the objects in the project_choices array in the update request.

", + "descriptionHTML": "

An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API\nrequest. If no parameters are provided, the import will be restarted.

\n

Some servers (e.g. TFS servers) can have several projects at a single URL. In those cases the import progress will\nhave the status detection_found_multiple and the Import Progress response will include a project_choices array.\nYou can select the project to import by providing one of the objects in the project_choices array in the update request.

\n

Warning: Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end\non October 17, 2023. For more details, see changelog. In the coming weeks, we will update\nthese docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.

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

Stop an import for a repository.

", + "descriptionHTML": "

Stop an import for a repository.

\n

Warning: Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end\non October 17, 2023. For more details, see changelog. In the coming weeks, we will update\nthese docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.

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

Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Enterprise Cloud Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username hubot into something like hubot <hubot@12341234-abab-fefe-8787-fedcba987654>.

\n

This endpoint and the Map a commit author endpoint allow you to provide correct Git author information.

", + "descriptionHTML": "

Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Enterprise Cloud Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username hubot into something like hubot <hubot@12341234-abab-fefe-8787-fedcba987654>.

\n

This endpoint and the Map a commit author endpoint allow you to provide correct Git author information.

\n

Warning: Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end\non October 17, 2023. For more details, see changelog. In the coming weeks, we will update\nthese docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.

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

Update an author's identity for the import. Your application can continue updating authors any time before you push new commits to the repository.

", + "descriptionHTML": "

Update an author's identity for the import. Your application can continue updating authors any time before you push\nnew commits to the repository.

\n

Warning: Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end\non October 17, 2023. For more details, see changelog. In the coming weeks, we will update\nthese docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.

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

List files larger than 100MB found during the import

", + "descriptionHTML": "

List files larger than 100MB found during the import

\n

Warning: Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end\non October 17, 2023. For more details, see changelog. In the coming weeks, we will update\nthese docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.

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

You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability is powered by Git LFS. You can learn more about our LFS feature and working with large files on our help site.

", + "descriptionHTML": "

You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability\nis powered by Git LFS.

\n

You can learn more about our LFS feature and working with large files on our help\nsite.

\n

Warning: Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end\non October 17, 2023. For more details, see changelog. In the coming weeks, we will update\nthese docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.

", "statusCodes": [ { "httpStatusCode": "200", @@ -523226,545 +523930,1817 @@ "type", "url" ] - } - ], - "type": [ - "null" - ] - }, - "identifiers": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type of identifier.", - "enum": [ - "CVE", - "GHSA" - ] - }, - "value": { - "type": "string", - "description": "The identifier value." - } + } + ], + "type": [ + "null" + ] + }, + "identifiers": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of identifier.", + "enum": [ + "CVE", + "GHSA" + ] + }, + "value": { + "type": "string", + "description": "The identifier value." + } + }, + "required": [ + "type", + "value" + ] + }, + "readOnly": true + }, + "state": { + "type": "string", + "description": "The state of the advisory.", + "enum": [ + "published", + "closed", + "withdrawn", + "draft", + "triage" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The date and time of when the advisory was created, in ISO 8601 format.", + "readOnly": true + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The date and time of when the advisory was last updated, in ISO 8601 format.", + "readOnly": true + }, + "published_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The date and time of when the advisory was published, in ISO 8601 format.", + "readOnly": true + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The date and time of when the advisory was closed, in ISO 8601 format.", + "readOnly": true + }, + "withdrawn_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The date and time of when the advisory was withdrawn, in ISO 8601 format.", + "readOnly": true + }, + "submission": { + "type": [ + "object", + "null" + ], + "readOnly": true, + "properties": { + "accepted": { + "type": "boolean", + "description": "Whether a private vulnerability report was accepted by the repository's administrators.", + "readOnly": true + } + }, + "required": [ + "accepted" + ] + }, + "vulnerabilities": { + "type": [ + "array", + "null" + ], + "items": { + "description": "A product affected by the vulnerability detailed in a repository security advisory.", + "type": "object", + "properties": { + "package": { + "description": "The name of the package affected by the vulnerability.", + "type": [ + "object", + "null" + ], + "properties": { + "ecosystem": { + "type": "string", + "description": "The package's language or package management ecosystem.", + "enum": [ + "rubygems", + "npm", + "pip", + "maven", + "nuget", + "composer", + "go", + "rust", + "erlang", + "actions", + "pub", + "other" + ] + }, + "name": { + "type": [ + "string", + "null" + ], + "description": "The unique package name within its ecosystem." + } + }, + "required": [ + "ecosystem", + "name" + ] + }, + "vulnerable_version_range": { + "type": [ + "string", + "null" + ], + "description": "The range of the package versions affected by the vulnerability." + }, + "patched_versions": { + "type": [ + "string", + "null" + ], + "description": "The package version(s) that resolve the vulnerability." + }, + "vulnerable_functions": { + "type": [ + "array", + "null" + ], + "description": "The functions in the package that are affected.", + "items": { + "type": "string" + } + } + }, + "required": [ + "package", + "vulnerable_version_range", + "patched_versions", + "vulnerable_functions" + ], + "additionalProperties": false + } + }, + "cvss": { + "type": [ + "object", + "null" + ], + "properties": { + "vector_string": { + "type": [ + "string", + "null" + ], + "description": "The CVSS vector." + }, + "score": { + "type": [ + "number", + "null" + ], + "description": "The CVSS score.", + "minimum": 0, + "maximum": 10, + "readOnly": true + } + }, + "required": [ + "vector_string", + "score" + ] + }, + "cwes": { + "type": [ + "array", + "null" + ], + "items": { + "type": "object", + "properties": { + "cwe_id": { + "type": "string", + "description": "The Common Weakness Enumeration (CWE) identifier." + }, + "name": { + "type": "string", + "description": "The name of the CWE.", + "readOnly": true + } + }, + "required": [ + "cwe_id", + "name" + ] + }, + "readOnly": true + }, + "cwe_ids": { + "type": [ + "array", + "null" + ], + "description": "A list of only the CWE IDs.", + "items": { + "type": "string" + } + }, + "credits": { + "type": [ + "array", + "null" + ], + "items": { + "type": "object", + "properties": { + "login": { + "type": "string", + "description": "The username of the user credited." + }, + "type": { + "type": "string", + "description": "The type of credit the user is receiving.", + "enum": [ + "analyst", + "finder", + "reporter", + "coordinator", + "remediation_developer", + "remediation_reviewer", + "remediation_verifier", + "tool", + "sponsor", + "other" + ] + } + } + } + }, + "credits_detailed": { + "type": [ + "array", + "null" + ], + "items": { + "description": "A credit given to a user for a repository security advisory.", + "type": "object", + "properties": { + "user": { + "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" + ] + }, + "type": { + "type": "string", + "description": "The type of credit the user is receiving.", + "enum": [ + "analyst", + "finder", + "reporter", + "coordinator", + "remediation_developer", + "remediation_reviewer", + "remediation_verifier", + "tool", + "sponsor", + "other" + ] + }, + "state": { + "type": "string", + "description": "The state of the user's acceptance of the credit.", + "enum": [ + "accepted", + "declined", + "pending" + ] + } + }, + "required": [ + "user", + "type", + "state" + ], + "additionalProperties": false + }, + "readOnly": true + } + }, + "required": [ + "ghsa_id", + "cve_id", + "url", + "html_url", + "summary", + "description", + "severity", + "author", + "publisher", + "identifiers", + "state", + "created_at", + "updated_at", + "published_at", + "closed_at", + "withdrawn_at", + "submission", + "vulnerabilities", + "cvss", + "cwes", + "cwe_ids", + "credits", + "credits_detailed" + ], + "additionalProperties": false + } + } + } + } + ], + "previews": [], + "descriptionHTML": "

Lists security advisories in a repository.\nYou must authenticate using an access token with the repo scope or repository_advisories:read permission\nin order to get published security advisories in a private repository, or any unpublished security advisories that you have access to.

\n

You can access unpublished security advisories from a repository if you are a security manager or administrator of that repository, or if you are a collaborator on any security advisory.

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

OK

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

Bad Request

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

Resource not found

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/security-advisories", + "title": "Create a repository security advisory", + "category": "security-advisories", + "subcategory": "repository-advisories", + "parameters": [ + { + "name": "owner", + "description": "

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

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

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

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

A short summary of the advisory.

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

A detailed description of what the advisory impacts.

", + "isRequired": true + }, + { + "type": "string or null", + "name": "cve_id", + "in": "body", + "description": "

The Common Vulnerabilities and Exposures (CVE) ID.

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

A product affected by the vulnerability detailed in a repository security advisory.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "package", + "description": "

The name of the package affected by the vulnerability.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ecosystem", + "description": "

The package's language or package management ecosystem.

", + "isRequired": true, + "enum": [ + "rubygems", + "npm", + "pip", + "maven", + "nuget", + "composer", + "go", + "rust", + "erlang", + "actions", + "pub", + "other" + ] + }, + { + "type": "string or null", + "name": "name", + "description": "

The unique package name within its ecosystem.

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

The range of the package versions affected by the vulnerability.

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

The package version(s) that resolve the vulnerability.

" + }, + { + "type": "array of strings or null", + "name": "vulnerable_functions", + "description": "

The functions in the package that are affected.

" + } + ] + }, + { + "type": "array of strings or null", + "name": "cwe_ids", + "in": "body", + "description": "

A list of Common Weakness Enumeration (CWE) IDs.

" + }, + { + "type": "array of objects or null", + "name": "credits", + "in": "body", + "description": "

A list of users receiving credit for their participation in the security advisory.

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

The username of the user credited.

", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "

The type of credit the user is receiving.

", + "isRequired": true, + "enum": [ + "analyst", + "finder", + "reporter", + "coordinator", + "remediation_developer", + "remediation_reviewer", + "remediation_verifier", + "tool", + "sponsor", + "other" + ] + } + ] + }, + { + "type": "string or null", + "name": "severity", + "in": "body", + "description": "

The severity of the advisory. You must choose between setting this field or cvss_vector_string.

", + "enum": [ + "critical", + "high", + "medium", + "low", + null + ] + }, + { + "type": "string or null", + "name": "cvss_vector_string", + "in": "body", + "description": "

The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or severity.

" + } + ], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "summary": "A new important advisory", + "description": "A more in-depth description of what the problem is.", + "severity": "high", + "cve_id": null, + "vulnerabilities": [ + { + "package": { + "name": "a-package", + "ecosystem": "npm" + }, + "vulnerable_version_range": "< 1.0.0", + "patched_versions": "1.0.0", + "vulnerable_functions": [ + "important_function" + ] + } + ], + "cwe_ids": [ + "CWE-1101", + "CWE-20" + ], + "credits": [ + { + "login": "monalisa", + "type": "reporter" + }, + { + "login": "octocat", + "type": "analyst" + } + ] + }, + "parameters": { + "owner": "OWNER", + "repo": "REPO" + } + }, + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "

Response

", + "example": { + "ghsa_id": "GHSA-abcd-1234-efgh", + "cve_id": "CVE-2050-00000", + "url": "https://api.github.com/repos/repo/a-package/security-advisories/GHSA-abcd-1234-efgh", + "html_url": "https://github.com/repo/a-package/security/advisories/GHSA-abcd-1234-efgh", + "summary": "A short summary of the advisory.", + "description": "A detailed description of what the advisory entails.", + "severity": "critical", + "author": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "publisher": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "identifiers": [ + { + "type": "GHSA", + "value": "GHSA-abcd-1234-efgh" + }, + { + "type": "CVE", + "value": "CVE-2050-00000" + } + ], + "state": "published", + "created_at": "2020-01-01T00:00:00Z", + "updated_at": "2020-01-02T00:00:00Z", + "published_at": "2020-01-03T00:00:00Z", + "closed_at": null, + "withdrawn_at": null, + "submission": null, + "vulnerabilities": [ + { + "package": { + "ecosystem": "pip", + "name": "a-package" + }, + "vulnerable_version_range": ">= 1.0.0, < 1.0.1", + "patched_versions": "1.0.1", + "vulnerable_functions": [ + "function1" + ] + }, + { + "package": { + "ecosystem": "pip", + "name": "another-package" + }, + "vulnerable_version_range": ">= 1.0.0, < 1.0.2", + "patched_versions": "1.0.2", + "vulnerable_functions": [ + "function2" + ] + } + ], + "cvss": { + "vector_string": "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H", + "score": 9.8 + }, + "cwes": [ + { + "cwe_id": "CWE-123", + "name": "A CWE" + } + ], + "cwe_ids": [ + "CWE-123" + ], + "credits": [ + { + "login": "octocat", + "type": "analyst" + } + ], + "credits_detailed": [ + { + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "type": "analyst", + "state": "accepted" + } + ] + }, + "schema": { + "description": "A repository security advisory.", + "type": "object", + "properties": { + "ghsa_id": { + "type": "string", + "description": "The GitHub Security Advisory ID.", + "readOnly": true + }, + "cve_id": { + "type": [ + "string", + "null" + ], + "description": "The Common Vulnerabilities and Exposures (CVE) ID." + }, + "url": { + "type": "string", + "description": "The API URL for the advisory." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL for the advisory.", + "readOnly": true + }, + "summary": { + "type": "string", + "description": "A short summary of the advisory.", + "maxLength": 1024 + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "A detailed description of what the advisory entails.", + "maxLength": 65535 + }, + "severity": { + "type": [ + "string", + "null" + ], + "description": "The severity of the advisory.", + "enum": [ + "critical", + "high", + "medium", + "low", + null + ] + }, + "author": { + "readOnly": true, + "description": "The author of the advisory.", + "allOf": [ + { + "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" + ] + } + ], + "type": [ + "null" + ] + }, + "publisher": { + "readOnly": true, + "description": "The publisher of the advisory.", + "allOf": [ + { + "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" + ] + } + ], + "type": [ + "null" + ] + }, + "identifiers": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of identifier.", + "enum": [ + "CVE", + "GHSA" + ] + }, + "value": { + "type": "string", + "description": "The identifier value." + } + }, + "required": [ + "type", + "value" + ] + }, + "readOnly": true + }, + "state": { + "type": "string", + "description": "The state of the advisory.", + "enum": [ + "published", + "closed", + "withdrawn", + "draft", + "triage" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The date and time of when the advisory was created, in ISO 8601 format.", + "readOnly": true + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The date and time of when the advisory was last updated, in ISO 8601 format.", + "readOnly": true + }, + "published_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The date and time of when the advisory was published, in ISO 8601 format.", + "readOnly": true + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The date and time of when the advisory was closed, in ISO 8601 format.", + "readOnly": true + }, + "withdrawn_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The date and time of when the advisory was withdrawn, in ISO 8601 format.", + "readOnly": true + }, + "submission": { + "type": [ + "object", + "null" + ], + "readOnly": true, + "properties": { + "accepted": { + "type": "boolean", + "description": "Whether a private vulnerability report was accepted by the repository's administrators.", + "readOnly": true + } + }, + "required": [ + "accepted" + ] + }, + "vulnerabilities": { + "type": [ + "array", + "null" + ], + "items": { + "description": "A product affected by the vulnerability detailed in a repository security advisory.", + "type": "object", + "properties": { + "package": { + "description": "The name of the package affected by the vulnerability.", + "type": [ + "object", + "null" + ], + "properties": { + "ecosystem": { + "type": "string", + "description": "The package's language or package management ecosystem.", + "enum": [ + "rubygems", + "npm", + "pip", + "maven", + "nuget", + "composer", + "go", + "rust", + "erlang", + "actions", + "pub", + "other" + ] + }, + "name": { + "type": [ + "string", + "null" + ], + "description": "The unique package name within its ecosystem." + } + }, + "required": [ + "ecosystem", + "name" + ] + }, + "vulnerable_version_range": { + "type": [ + "string", + "null" + ], + "description": "The range of the package versions affected by the vulnerability." + }, + "patched_versions": { + "type": [ + "string", + "null" + ], + "description": "The package version(s) that resolve the vulnerability." + }, + "vulnerable_functions": { + "type": [ + "array", + "null" + ], + "description": "The functions in the package that are affected.", + "items": { + "type": "string" + } + } + }, + "required": [ + "package", + "vulnerable_version_range", + "patched_versions", + "vulnerable_functions" + ], + "additionalProperties": false + } + }, + "cvss": { + "type": [ + "object", + "null" + ], + "properties": { + "vector_string": { + "type": [ + "string", + "null" + ], + "description": "The CVSS vector." + }, + "score": { + "type": [ + "number", + "null" + ], + "description": "The CVSS score.", + "minimum": 0, + "maximum": 10, + "readOnly": true + } + }, + "required": [ + "vector_string", + "score" + ] + }, + "cwes": { + "type": [ + "array", + "null" + ], + "items": { + "type": "object", + "properties": { + "cwe_id": { + "type": "string", + "description": "The Common Weakness Enumeration (CWE) identifier." + }, + "name": { + "type": "string", + "description": "The name of the CWE.", + "readOnly": true + } + }, + "required": [ + "cwe_id", + "name" + ] + }, + "readOnly": true + }, + "cwe_ids": { + "type": [ + "array", + "null" + ], + "description": "A list of only the CWE IDs.", + "items": { + "type": "string" + } + }, + "credits": { + "type": [ + "array", + "null" + ], + "items": { + "type": "object", + "properties": { + "login": { + "type": "string", + "description": "The username of the user credited." + }, + "type": { + "type": "string", + "description": "The type of credit the user is receiving.", + "enum": [ + "analyst", + "finder", + "reporter", + "coordinator", + "remediation_developer", + "remediation_reviewer", + "remediation_verifier", + "tool", + "sponsor", + "other" + ] + } + } + } + }, + "credits_detailed": { + "type": [ + "array", + "null" + ], + "items": { + "description": "A credit given to a user for a repository security advisory.", + "type": "object", + "properties": { + "user": { + "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" + ] }, - "required": [ - "type", - "value" - ] - }, - "readOnly": true - }, - "state": { - "type": "string", - "description": "The state of the advisory.", - "enum": [ - "published", - "closed", - "withdrawn", - "draft", - "triage" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The date and time of when the advisory was created, in ISO 8601 format.", - "readOnly": true - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The date and time of when the advisory was last updated, in ISO 8601 format.", - "readOnly": true - }, - "published_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The date and time of when the advisory was published, in ISO 8601 format.", - "readOnly": true - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The date and time of when the advisory was closed, in ISO 8601 format.", - "readOnly": true - }, - "withdrawn_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The date and time of when the advisory was withdrawn, in ISO 8601 format.", - "readOnly": true - }, - "submission": { - "type": [ - "object", - "null" - ], - "readOnly": true, - "properties": { - "accepted": { - "type": "boolean", - "description": "Whether a private vulnerability report was accepted by the repository's administrators.", - "readOnly": true - } - }, - "required": [ - "accepted" - ] - }, - "vulnerabilities": { - "type": [ - "array", - "null" - ], - "items": { - "description": "A product affected by the vulnerability detailed in a repository security advisory.", - "type": "object", - "properties": { - "package": { - "description": "The name of the package affected by the vulnerability.", - "type": [ - "object", - "null" - ], - "properties": { - "ecosystem": { - "type": "string", - "description": "The package's language or package management ecosystem.", - "enum": [ - "rubygems", - "npm", - "pip", - "maven", - "nuget", - "composer", - "go", - "rust", - "erlang", - "actions", - "pub", - "other" - ] - }, - "name": { - "type": [ - "string", - "null" - ], - "description": "The unique package name within its ecosystem." - } - }, - "required": [ - "ecosystem", - "name" - ] - }, - "vulnerable_version_range": { - "type": [ - "string", - "null" - ], - "description": "The range of the package versions affected by the vulnerability." - }, - "patched_versions": { - "type": [ - "string", - "null" - ], - "description": "The package version(s) that resolve the vulnerability." - }, - "vulnerable_functions": { - "type": [ - "array", - "null" - ], - "description": "The functions in the package that are affected.", - "items": { - "type": "string" - } - } - }, - "required": [ - "package", - "vulnerable_version_range", - "patched_versions", - "vulnerable_functions" - ], - "additionalProperties": false - } - }, - "cvss": { - "type": [ - "object", - "null" - ], - "properties": { - "vector_string": { - "type": [ - "string", - "null" - ], - "description": "The CVSS vector." + "type": { + "type": "string", + "description": "The type of credit the user is receiving.", + "enum": [ + "analyst", + "finder", + "reporter", + "coordinator", + "remediation_developer", + "remediation_reviewer", + "remediation_verifier", + "tool", + "sponsor", + "other" + ] }, - "score": { - "type": [ - "number", - "null" - ], - "description": "The CVSS score.", - "minimum": 0, - "maximum": 10, - "readOnly": true + "state": { + "type": "string", + "description": "The state of the user's acceptance of the credit.", + "enum": [ + "accepted", + "declined", + "pending" + ] } }, "required": [ - "vector_string", - "score" - ] - }, - "cwes": { - "type": [ - "array", - "null" - ], - "items": { - "type": "object", - "properties": { - "cwe_id": { - "type": "string", - "description": "The Common Weakness Enumeration (CWE) identifier." - }, - "name": { - "type": "string", - "description": "The name of the CWE.", - "readOnly": true - } - }, - "required": [ - "cwe_id", - "name" - ] - }, - "readOnly": true - }, - "cwe_ids": { - "type": [ - "array", - "null" - ], - "description": "A list of only the CWE IDs.", - "items": { - "type": "string" - } - }, - "credits": { - "type": [ - "array", - "null" + "user", + "type", + "state" ], - "items": { - "type": "object", - "properties": { - "login": { - "type": "string", - "description": "The username of the user credited." - }, - "type": { - "type": "string", - "description": "The type of credit the user is receiving.", - "enum": [ - "analyst", - "finder", - "reporter", - "coordinator", - "remediation_developer", - "remediation_reviewer", - "remediation_verifier", - "tool", - "sponsor", - "other" - ] - } - } - } + "additionalProperties": false }, - "credits_detailed": { - "type": [ - "array", - "null" - ], - "items": { - "description": "A credit given to a user for a repository security advisory.", - "type": "object", - "properties": { - "user": { - "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" - ] - }, - "type": { - "type": "string", - "description": "The type of credit the user is receiving.", - "enum": [ - "analyst", - "finder", - "reporter", - "coordinator", - "remediation_developer", - "remediation_reviewer", - "remediation_verifier", - "tool", - "sponsor", - "other" - ] - }, - "state": { - "type": "string", - "description": "The state of the user's acceptance of the credit.", - "enum": [ - "accepted", - "declined", - "pending" - ] - } - }, - "required": [ - "user", - "type", - "state" - ], - "additionalProperties": false - }, - "readOnly": true - } - }, - "required": [ - "ghsa_id", - "cve_id", - "url", - "html_url", - "summary", - "description", - "severity", - "author", - "publisher", - "identifiers", - "state", - "created_at", - "updated_at", - "published_at", - "closed_at", - "withdrawn_at", - "submission", - "vulnerabilities", - "cvss", - "cwes", - "cwe_ids", - "credits", - "credits_detailed" - ], - "additionalProperties": false - } + "readOnly": true + } + }, + "required": [ + "ghsa_id", + "cve_id", + "url", + "html_url", + "summary", + "description", + "severity", + "author", + "publisher", + "identifiers", + "state", + "created_at", + "updated_at", + "published_at", + "closed_at", + "withdrawn_at", + "submission", + "vulnerabilities", + "cvss", + "cwes", + "cwe_ids", + "credits", + "credits_detailed" + ], + "additionalProperties": false } } } ], "previews": [], - "descriptionHTML": "

Lists security advisories in a repository.\nYou must authenticate using an access token with the repo scope or repository_advisories:read permission\nin order to get published security advisories in a private repository, or any unpublished security advisories that you have access to.

\n

You can access unpublished security advisories from a repository if you are a security manager or administrator of that repository, or if you are a collaborator on any security advisory.

", + "descriptionHTML": "

Creates a new repository security advisory.\nYou must authenticate using an access token with the repo scope or repository_advisories:write permission to use this endpoint.

\n

In order to create a draft repository security advisory, you must be a security manager or administrator of that repository.

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

OK

" + "httpStatusCode": "201", + "description": "

Created

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

Bad Request

" + "httpStatusCode": "403", + "description": "

Forbidden

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

Resource not found

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

Validation failed, or the endpoint has been spammed.

" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", - "requestPath": "/repos/{owner}/{repo}/security-advisories", - "title": "Create a repository security advisory", + "requestPath": "/repos/{owner}/{repo}/security-advisories/reports", + "title": "Privately report a security vulnerability", "category": "security-advisories", "subcategory": "repository-advisories", "parameters": [ @@ -523803,17 +525779,10 @@ "isRequired": true }, { - "type": "string or null", - "name": "cve_id", - "in": "body", - "description": "

The Common Vulnerabilities and Exposures (CVE) ID.

" - }, - { - "type": "array of objects", + "type": "array of objects or null", "name": "vulnerabilities", "in": "body", - "description": "

A product affected by the vulnerability detailed in a repository security advisory.

", - "isRequired": true, + "description": "

An array of products affected by the vulnerability detailed in a repository security advisory.

", "childParamsGroups": [ { "type": "object", @@ -523871,38 +525840,6 @@ "in": "body", "description": "

A list of Common Weakness Enumeration (CWE) IDs.

" }, - { - "type": "array of objects or null", - "name": "credits", - "in": "body", - "description": "

A list of users receiving credit for their participation in the security advisory.

", - "childParamsGroups": [ - { - "type": "string", - "name": "login", - "description": "

The username of the user credited.

", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "

The type of credit the user is receiving.

", - "isRequired": true, - "enum": [ - "analyst", - "finder", - "reporter", - "coordinator", - "remediation_developer", - "remediation_reviewer", - "remediation_verifier", - "tool", - "sponsor", - "other" - ] - } - ] - }, { "type": "string or null", "name": "severity", @@ -523932,10 +525869,9 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "summary": "A new important advisory", + "summary": "A newly discovered vulnerability", "description": "A more in-depth description of what the problem is.", "severity": "high", - "cve_id": null, "vulnerabilities": [ { "package": { @@ -523950,18 +525886,7 @@ } ], "cwe_ids": [ - "CWE-1101", - "CWE-20" - ], - "credits": [ - { - "login": "monalisa", - "type": "reporter" - }, - { - "login": "octocat", - "type": "analyst" - } + "CWE-123" ] }, "parameters": { @@ -523978,9 +525903,9 @@ "cve_id": "CVE-2050-00000", "url": "https://api.github.com/repos/repo/a-package/security-advisories/GHSA-abcd-1234-efgh", "html_url": "https://github.com/repo/a-package/security/advisories/GHSA-abcd-1234-efgh", - "summary": "A short summary of the advisory.", - "description": "A detailed description of what the advisory entails.", - "severity": "critical", + "summary": "A newly discovered vulnerability", + "description": "A more in-depth description of what the problem is.", + "severity": "high", "author": { "login": "octocat", "id": 1, @@ -524001,26 +525926,7 @@ "type": "User", "site_admin": false }, - "publisher": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, + "publisher": null, "identifiers": [ { "type": "GHSA", @@ -524028,44 +525934,32 @@ }, { "type": "CVE", - "value": "CVE-2050-00000" + "value": null } ], - "state": "published", + "state": "triage", "created_at": "2020-01-01T00:00:00Z", "updated_at": "2020-01-02T00:00:00Z", - "published_at": "2020-01-03T00:00:00Z", + "published_at": null, "closed_at": null, "withdrawn_at": null, - "submission": null, + "submission": { + "accepted": false + }, "vulnerabilities": [ { "package": { - "ecosystem": "pip", + "ecosystem": "npm", "name": "a-package" }, - "vulnerable_version_range": ">= 1.0.0, < 1.0.1", - "patched_versions": "1.0.1", - "vulnerable_functions": [ - "function1" - ] - }, - { - "package": { - "ecosystem": "pip", - "name": "another-package" - }, - "vulnerable_version_range": ">= 1.0.0, < 1.0.2", - "patched_versions": "1.0.2", + "vulnerable_version_range": "< 1.0.0", + "patched_versions": "1.0.0", "vulnerable_functions": [ - "function2" + "important_function" ] } ], - "cvss": { - "vector_string": "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H", - "score": 9.8 - }, + "cvss": null, "cwes": [ { "cwe_id": "CWE-123", @@ -524078,7 +525972,7 @@ "credits": [ { "login": "octocat", - "type": "analyst" + "type": "finder" } ], "credits_detailed": [ @@ -524103,7 +525997,7 @@ "type": "User", "site_admin": false }, - "type": "analyst", + "type": "finder", "state": "accepted" } ] @@ -525012,7 +526906,7 @@ } ], "previews": [], - "descriptionHTML": "

Creates a new repository security advisory.\nYou must authenticate using an access token with the repo scope or repository_advisories:write permission to use this endpoint.

\n

In order to create a draft repository security advisory, you must be a security manager or administrator of that repository.

", + "descriptionHTML": "

Report a security vulnerability to the maintainers of the repository.\nSee \"Privately reporting a security vulnerability\" for more information about private vulnerability reporting.

", "statusCodes": [ { "httpStatusCode": "201", diff --git a/src/rest/data/ghes-3.4/schema.json b/src/rest/data/ghes-3.4/schema.json index 507b2dcf10fd..2245aebb481a 100644 --- a/src/rest/data/ghes-3.4/schema.json +++ b/src/rest/data/ghes-3.4/schema.json @@ -49003,8 +49003,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

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

", "statusCodes": [ { "httpStatusCode": "200", diff --git a/src/rest/data/ghes-3.5/schema.json b/src/rest/data/ghes-3.5/schema.json index 93b13b2ad2b7..b866749c64c9 100644 --- a/src/rest/data/ghes-3.5/schema.json +++ b/src/rest/data/ghes-3.5/schema.json @@ -54647,8 +54647,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

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

", "statusCodes": [ { "httpStatusCode": "200", diff --git a/src/rest/data/ghes-3.6/schema.json b/src/rest/data/ghes-3.6/schema.json index caa3c2decb4e..12ea53275249 100644 --- a/src/rest/data/ghes-3.6/schema.json +++ b/src/rest/data/ghes-3.6/schema.json @@ -56150,8 +56150,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

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

", "statusCodes": [ { "httpStatusCode": "200", diff --git a/src/rest/data/ghes-3.7/schema.json b/src/rest/data/ghes-3.7/schema.json index 8ae760f035ad..8e04ff233e2e 100644 --- a/src/rest/data/ghes-3.7/schema.json +++ b/src/rest/data/ghes-3.7/schema.json @@ -57044,8 +57044,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

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

", "statusCodes": [ { "httpStatusCode": "200", diff --git a/src/rest/data/ghes-3.8/schema.json b/src/rest/data/ghes-3.8/schema.json index 34916ba55aa2..91cf06ac8525 100644 --- a/src/rest/data/ghes-3.8/schema.json +++ b/src/rest/data/ghes-3.8/schema.json @@ -71214,8 +71214,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

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

", "statusCodes": [ { "httpStatusCode": "200", diff --git a/src/rest/lib/config.json b/src/rest/lib/config.json index 706e3443c10a..a43867815215 100644 --- a/src/rest/lib/config.json +++ b/src/rest/lib/config.json @@ -30,5 +30,5 @@ ] } }, - "sha": "955d6a6a61c413f2940b977647300f1c609b0ec6" + "sha": "cf133481cb255f2119fe875dcfde3e047d2017b7" } \ No newline at end of file diff --git a/src/webhooks/data/fpt/schema.json b/src/webhooks/data/fpt/schema.json index 9bf7b517826b..2c479157b735 100644 --- a/src/webhooks/data/fpt/schema.json +++ b/src/webhooks/data/fpt/schema.json @@ -21202,6 +21202,3745 @@ "category": "deployment" } }, + "deployment_protection_rule": { + "requested": { + "descriptionHtml": "

A deployment protection rule was requested for an environment.

", + "summaryHtml": "

This event occurs when there is activity relating to deployment protection rules. For more information, see \"Using environments for deployment.\" For information about the API to manage deployment protection rules, see the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "enum": [ + "requested" + ], + "childParamsGroups": [] + }, + { + "type": "string", + "name": "environment", + "in": "body", + "description": "

The name of the environment that has the deployment protection rule.

" + }, + { + "type": "string", + "name": "event", + "in": "body", + "description": "

The event that triggered the deployment protection rule.

" + }, + { + "type": "string", + "name": "deployment_callback_url", + "in": "body", + "description": "

The URL to review the deployment protection rule.

" + }, + { + "type": "object", + "name": "deployment", + "in": "body", + "description": "

A request for a specific ref(branch,sha,tag) to be deployed

", + "childParamsGroups": [ + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "

Unique identifier of the deployment

", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "description": "

The ref to deploy. This can be a branch, tag, or sha.

", + "isRequired": true + }, + { + "type": "string", + "name": "task", + "description": "

Parameter to specify a task to execute

", + "isRequired": true + }, + { + "type": "object or string", + "name": "payload", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "original_environment", + "description": "" + }, + { + "type": "string", + "name": "environment", + "description": "

Name for the target deployment environment.

", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "creator", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "statuses_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "transient_environment", + "description": "

Specifies if the given environment is will no longer exist at some point in the future. Default: false.

" + }, + { + "type": "boolean", + "name": "production_environment", + "description": "

Specifies if the given environment is one that end-users directly interact with. Default: false.

" + }, + { + "type": "object", + "name": "performed_via_github_app", + "description": "

GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.

", + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "

Unique identifier of the GitHub app

", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "

The slug name of the GitHub app

" + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "owner", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string", + "name": "name", + "description": "

The name of the GitHub app

", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "external_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "permissions", + "description": "

The set of permissions for the GitHub app

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "issues", + "description": "" + }, + { + "type": "string", + "name": "checks", + "description": "" + }, + { + "type": "string", + "name": "metadata", + "description": "" + }, + { + "type": "string", + "name": "contents", + "description": "" + }, + { + "type": "string", + "name": "deployments", + "description": "" + } + ] + }, + { + "type": "array of strings", + "name": "events", + "description": "

The list of events for the GitHub app

", + "isRequired": true + }, + { + "type": "integer", + "name": "installations_count", + "description": "

The number of installations associated with the GitHub app

" + }, + { + "type": "string", + "name": "client_id", + "description": "" + }, + { + "type": "string", + "name": "client_secret", + "description": "" + }, + { + "type": "string or null", + "name": "webhook_secret", + "description": "" + }, + { + "type": "string", + "name": "pem", + "description": "" + } + ] + } + ] + }, + { + "type": "array of objects", + "name": "pull_requests", + "in": "body", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "diff_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "patch_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "review_comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "review_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "statuses_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "

Number uniquely identifying the pull request within its repository.

", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "

State of this Pull Request. Either open or closed.

", + "isRequired": true, + "enum": [ + "open", + "closed" + ] + }, + { + "type": "boolean", + "name": "locked", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "title", + "description": "

The title of the pull request.

", + "isRequired": true + }, + { + "type": "object", + "name": "user", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "body", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "labels", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "color", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "default", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "milestone", + "description": "

A collection of related issues and pull requests.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "

The number of the milestone.

", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "

The state of the milestone.

", + "isRequired": true, + "enum": [ + "open", + "closed" + ], + "default": "open" + }, + { + "type": "string", + "name": "title", + "description": "

The title of the milestone.

", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "creator", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "closed_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "due_on", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string or null", + "name": "active_lock_reason", + "description": "" + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "merged_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "merge_commit_sha", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "assignee", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "array of objects or null", + "name": "assignees", + "description": "", + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "array of objects or null", + "name": "requested_reviewers", + "description": "", + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "array of objects or null", + "name": "requested_teams", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "

Unique identifier of the team

", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "

URL for the team

", + "isRequired": true + }, + { + "type": "string", + "name": "members_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

Name of the team

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

Description of the team

", + "isRequired": true + }, + { + "type": "string", + "name": "permission", + "description": "

Permission that the team will have for its repositories

", + "isRequired": true + }, + { + "type": "string", + "name": "privacy", + "description": "

The level of privacy this team should have

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

The notification setting the team has set

" + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repositories_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ldap_dn", + "description": "

Distinguished Name (DN) that team maps to within LDAP environment

" + } + ] + }, + { + "type": "object", + "name": "head", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "label", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "repo", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "archive_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "assignees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "blobs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "branches_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "collaborators_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "compare_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contents_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contributors_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "deployments_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "downloads_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "fork", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "forks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_refs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "hooks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issues_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "keys_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "languages_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "merges_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "milestones_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "notifications_url", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "pulls_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "releases_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "stargazers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "statuses_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscribers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscription_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "teams_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "trees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "clone_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "default_branch", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_downloads", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_issues", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_projects", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_wiki", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_pages", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_discussions", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "homepage", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "language", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "master_branch", + "description": "" + }, + { + "type": "boolean", + "name": "archived", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "disabled", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "visibility", + "description": "

The repository visibility: public, private, or internal.

" + }, + { + "type": "string or null", + "name": "mirror_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues_count", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "permissions", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "admin", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintain", + "description": "" + }, + { + "type": "boolean", + "name": "push", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "triage", + "description": "" + }, + { + "type": "boolean", + "name": "pull", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "temp_clone_token", + "description": "" + }, + { + "type": "boolean", + "name": "allow_merge_commit", + "description": "" + }, + { + "type": "boolean", + "name": "allow_squash_merge", + "description": "" + }, + { + "type": "boolean", + "name": "allow_rebase_merge", + "description": "" + }, + { + "type": "object or null", + "name": "license", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "spdx_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "pushed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "size", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ssh_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "stargazers_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "svn_url", + "description": "", + "isRequired": true + }, + { + "type": "array of strings", + "name": "topics", + "description": "" + }, + { + "type": "integer", + "name": "watchers", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "watchers_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "allow_forking", + "description": "" + }, + { + "type": "boolean", + "name": "is_template", + "description": "" + }, + { + "type": "boolean", + "name": "web_commit_signoff_required", + "description": "" + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + } + ] + }, + { + "type": "object", + "name": "base", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "label", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "archive_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "assignees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "blobs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "branches_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "collaborators_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "compare_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contents_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contributors_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "deployments_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "downloads_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "fork", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "forks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_refs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "hooks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_template", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issues_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "keys_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "languages_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "merges_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "milestones_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "notifications_url", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "pulls_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "releases_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "stargazers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "statuses_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscribers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscription_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "teams_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "trees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "clone_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "default_branch", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_downloads", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_issues", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_projects", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_wiki", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_pages", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_discussions", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "homepage", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "language", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "master_branch", + "description": "" + }, + { + "type": "boolean", + "name": "archived", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "disabled", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "visibility", + "description": "

The repository visibility: public, private, or internal.

" + }, + { + "type": "string or null", + "name": "mirror_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues_count", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "permissions", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "admin", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintain", + "description": "" + }, + { + "type": "boolean", + "name": "push", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "triage", + "description": "" + }, + { + "type": "boolean", + "name": "pull", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "temp_clone_token", + "description": "" + }, + { + "type": "boolean", + "name": "allow_merge_commit", + "description": "" + }, + { + "type": "boolean", + "name": "allow_squash_merge", + "description": "" + }, + { + "type": "boolean", + "name": "allow_rebase_merge", + "description": "" + }, + { + "type": "object", + "name": "license", + "description": "

License Simple

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "spdx_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "" + } + ] + }, + { + "type": "string", + "name": "pushed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "size", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ssh_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "stargazers_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "svn_url", + "description": "", + "isRequired": true + }, + { + "type": "array of strings", + "name": "topics", + "description": "" + }, + { + "type": "integer", + "name": "watchers", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "watchers_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "allow_forking", + "description": "" + }, + { + "type": "boolean", + "name": "web_commit_signoff_required", + "description": "" + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + } + ] + }, + { + "type": "object", + "name": "_links", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "comments", + "description": "

Hypermedia Link

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "commits", + "description": "

Hypermedia Link

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "statuses", + "description": "

Hypermedia Link

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "html", + "description": "

Hypermedia Link

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "issue", + "description": "

Hypermedia Link

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "review_comments", + "description": "

Hypermedia Link

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "review_comment", + "description": "

Hypermedia Link

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "self", + "description": "

Hypermedia Link

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + } + ] + }, + { + "type": "string", + "name": "author_association", + "description": "

How the author is associated with the repository.

", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "object or null", + "name": "auto_merge", + "description": "

The status of auto merging a pull request.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "enabled_by", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string", + "name": "merge_method", + "description": "

The merge method to use.

", + "isRequired": true, + "enum": [ + "merge", + "squash", + "rebase" + ] + }, + { + "type": "string", + "name": "commit_title", + "description": "

Title for the merge commit message.

", + "isRequired": true + }, + { + "type": "string", + "name": "commit_message", + "description": "

Commit message for the merge commit.

", + "isRequired": true + } + ] + }, + { + "type": "boolean", + "name": "draft", + "description": "

Indicates whether or not the pull request is a draft.

" + }, + { + "type": "boolean", + "name": "merged", + "description": "", + "isRequired": true + }, + { + "type": "boolean or null", + "name": "mergeable", + "description": "", + "isRequired": true + }, + { + "type": "boolean or null", + "name": "rebaseable", + "description": "" + }, + { + "type": "string", + "name": "mergeable_state", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "merged_by", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "integer", + "name": "comments", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "review_comments", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintainer_can_modify", + "description": "

Indicates whether maintainers can modify the pull request.

", + "isRequired": true + }, + { + "type": "integer", + "name": "commits", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "additions", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "deletions", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "changed_files", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "childParamsGroups": [] + } + ], + "availability": [ + "app" + ], + "action": "requested", + "category": "deployment_protection_rule" + } + }, "deployment_status": { "created": { "descriptionHtml": "

A new deployment status was created.

", diff --git a/src/webhooks/data/ghae/schema.json b/src/webhooks/data/ghae/schema.json index 5a544e7ec18b..32fd5c5a3923 100644 --- a/src/webhooks/data/ghae/schema.json +++ b/src/webhooks/data/ghae/schema.json @@ -20982,6 +20982,3745 @@ "category": "deployment" } }, + "deployment_protection_rule": { + "requested": { + "descriptionHtml": "

A deployment protection rule was requested for an environment.

", + "summaryHtml": "

This event occurs when there is activity relating to deployment protection rules. For more information, see \"Using environments for deployment.\" For information about the API to manage deployment protection rules, see the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "enum": [ + "requested" + ], + "childParamsGroups": [] + }, + { + "type": "string", + "name": "environment", + "in": "body", + "description": "

The name of the environment that has the deployment protection rule.

" + }, + { + "type": "string", + "name": "event", + "in": "body", + "description": "

The event that triggered the deployment protection rule.

" + }, + { + "type": "string", + "name": "deployment_callback_url", + "in": "body", + "description": "

The URL to review the deployment protection rule.

" + }, + { + "type": "object", + "name": "deployment", + "in": "body", + "description": "

A request for a specific ref(branch,sha,tag) to be deployed

", + "childParamsGroups": [ + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "

Unique identifier of the deployment

", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "description": "

The ref to deploy. This can be a branch, tag, or sha.

", + "isRequired": true + }, + { + "type": "string", + "name": "task", + "description": "

Parameter to specify a task to execute

", + "isRequired": true + }, + { + "type": "object or string", + "name": "payload", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "original_environment", + "description": "" + }, + { + "type": "string", + "name": "environment", + "description": "

Name for the target deployment environment.

", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "creator", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "statuses_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "transient_environment", + "description": "

Specifies if the given environment is will no longer exist at some point in the future. Default: false.

" + }, + { + "type": "boolean", + "name": "production_environment", + "description": "

Specifies if the given environment is one that end-users directly interact with. Default: false.

" + }, + { + "type": "object", + "name": "performed_via_github_app", + "description": "

GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.

", + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "

Unique identifier of the GitHub app

", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "

The slug name of the GitHub app

" + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "owner", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string", + "name": "name", + "description": "

The name of the GitHub app

", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "external_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "permissions", + "description": "

The set of permissions for the GitHub app

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "issues", + "description": "" + }, + { + "type": "string", + "name": "checks", + "description": "" + }, + { + "type": "string", + "name": "metadata", + "description": "" + }, + { + "type": "string", + "name": "contents", + "description": "" + }, + { + "type": "string", + "name": "deployments", + "description": "" + } + ] + }, + { + "type": "array of strings", + "name": "events", + "description": "

The list of events for the GitHub app

", + "isRequired": true + }, + { + "type": "integer", + "name": "installations_count", + "description": "

The number of installations associated with the GitHub app

" + }, + { + "type": "string", + "name": "client_id", + "description": "" + }, + { + "type": "string", + "name": "client_secret", + "description": "" + }, + { + "type": "string or null", + "name": "webhook_secret", + "description": "" + }, + { + "type": "string", + "name": "pem", + "description": "" + } + ] + } + ] + }, + { + "type": "array of objects", + "name": "pull_requests", + "in": "body", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "diff_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "patch_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "review_comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "review_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "statuses_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "

Number uniquely identifying the pull request within its repository.

", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "

State of this Pull Request. Either open or closed.

", + "isRequired": true, + "enum": [ + "open", + "closed" + ] + }, + { + "type": "boolean", + "name": "locked", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "title", + "description": "

The title of the pull request.

", + "isRequired": true + }, + { + "type": "object", + "name": "user", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "body", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "labels", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "color", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "default", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "milestone", + "description": "

A collection of related issues and pull requests.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "

The number of the milestone.

", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "

The state of the milestone.

", + "isRequired": true, + "enum": [ + "open", + "closed" + ], + "default": "open" + }, + { + "type": "string", + "name": "title", + "description": "

The title of the milestone.

", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "creator", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "closed_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "due_on", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string or null", + "name": "active_lock_reason", + "description": "" + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "merged_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "merge_commit_sha", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "assignee", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "array of objects or null", + "name": "assignees", + "description": "", + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "array of objects or null", + "name": "requested_reviewers", + "description": "", + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "array of objects or null", + "name": "requested_teams", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "

Unique identifier of the team

", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "

URL for the team

", + "isRequired": true + }, + { + "type": "string", + "name": "members_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

Name of the team

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

Description of the team

", + "isRequired": true + }, + { + "type": "string", + "name": "permission", + "description": "

Permission that the team will have for its repositories

", + "isRequired": true + }, + { + "type": "string", + "name": "privacy", + "description": "

The level of privacy this team should have

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

The notification setting the team has set

" + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repositories_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ldap_dn", + "description": "

Distinguished Name (DN) that team maps to within LDAP environment

" + } + ] + }, + { + "type": "object", + "name": "head", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "label", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "repo", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "archive_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "assignees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "blobs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "branches_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "collaborators_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "compare_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contents_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contributors_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "deployments_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "downloads_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "fork", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "forks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_refs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "hooks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issues_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "keys_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "languages_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "merges_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "milestones_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "notifications_url", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "pulls_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "releases_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "stargazers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "statuses_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscribers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscription_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "teams_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "trees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "clone_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "default_branch", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_downloads", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_issues", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_projects", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_wiki", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_pages", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_discussions", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "homepage", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "language", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "master_branch", + "description": "" + }, + { + "type": "boolean", + "name": "archived", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "disabled", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "visibility", + "description": "

The repository visibility: public, private, or internal.

" + }, + { + "type": "string or null", + "name": "mirror_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues_count", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "permissions", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "admin", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintain", + "description": "" + }, + { + "type": "boolean", + "name": "push", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "triage", + "description": "" + }, + { + "type": "boolean", + "name": "pull", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "temp_clone_token", + "description": "" + }, + { + "type": "boolean", + "name": "allow_merge_commit", + "description": "" + }, + { + "type": "boolean", + "name": "allow_squash_merge", + "description": "" + }, + { + "type": "boolean", + "name": "allow_rebase_merge", + "description": "" + }, + { + "type": "object or null", + "name": "license", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "spdx_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "pushed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "size", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ssh_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "stargazers_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "svn_url", + "description": "", + "isRequired": true + }, + { + "type": "array of strings", + "name": "topics", + "description": "" + }, + { + "type": "integer", + "name": "watchers", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "watchers_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "allow_forking", + "description": "" + }, + { + "type": "boolean", + "name": "is_template", + "description": "" + }, + { + "type": "boolean", + "name": "web_commit_signoff_required", + "description": "" + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + } + ] + }, + { + "type": "object", + "name": "base", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "label", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "archive_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "assignees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "blobs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "branches_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "collaborators_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "compare_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contents_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contributors_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "deployments_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "downloads_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "fork", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "forks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_refs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "hooks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_template", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issues_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "keys_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "languages_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "merges_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "milestones_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "notifications_url", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "pulls_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "releases_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "stargazers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "statuses_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscribers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscription_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "teams_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "trees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "clone_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "default_branch", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_downloads", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_issues", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_projects", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_wiki", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_pages", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_discussions", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "homepage", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "language", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "master_branch", + "description": "" + }, + { + "type": "boolean", + "name": "archived", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "disabled", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "visibility", + "description": "

The repository visibility: public, private, or internal.

" + }, + { + "type": "string or null", + "name": "mirror_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues_count", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "permissions", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "admin", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintain", + "description": "" + }, + { + "type": "boolean", + "name": "push", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "triage", + "description": "" + }, + { + "type": "boolean", + "name": "pull", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "temp_clone_token", + "description": "" + }, + { + "type": "boolean", + "name": "allow_merge_commit", + "description": "" + }, + { + "type": "boolean", + "name": "allow_squash_merge", + "description": "" + }, + { + "type": "boolean", + "name": "allow_rebase_merge", + "description": "" + }, + { + "type": "object", + "name": "license", + "description": "

License Simple

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "spdx_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "" + } + ] + }, + { + "type": "string", + "name": "pushed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "size", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ssh_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "stargazers_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "svn_url", + "description": "", + "isRequired": true + }, + { + "type": "array of strings", + "name": "topics", + "description": "" + }, + { + "type": "integer", + "name": "watchers", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "watchers_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "allow_forking", + "description": "" + }, + { + "type": "boolean", + "name": "web_commit_signoff_required", + "description": "" + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + } + ] + }, + { + "type": "object", + "name": "_links", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "comments", + "description": "

Hypermedia Link

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "commits", + "description": "

Hypermedia Link

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "statuses", + "description": "

Hypermedia Link

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "html", + "description": "

Hypermedia Link

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "issue", + "description": "

Hypermedia Link

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "review_comments", + "description": "

Hypermedia Link

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "review_comment", + "description": "

Hypermedia Link

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "self", + "description": "

Hypermedia Link

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + } + ] + }, + { + "type": "string", + "name": "author_association", + "description": "

How the author is associated with the repository.

", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "object or null", + "name": "auto_merge", + "description": "

The status of auto merging a pull request.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "enabled_by", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string", + "name": "merge_method", + "description": "

The merge method to use.

", + "isRequired": true, + "enum": [ + "merge", + "squash", + "rebase" + ] + }, + { + "type": "string", + "name": "commit_title", + "description": "

Title for the merge commit message.

", + "isRequired": true + }, + { + "type": "string", + "name": "commit_message", + "description": "

Commit message for the merge commit.

", + "isRequired": true + } + ] + }, + { + "type": "boolean", + "name": "draft", + "description": "

Indicates whether or not the pull request is a draft.

" + }, + { + "type": "boolean", + "name": "merged", + "description": "", + "isRequired": true + }, + { + "type": "boolean or null", + "name": "mergeable", + "description": "", + "isRequired": true + }, + { + "type": "boolean or null", + "name": "rebaseable", + "description": "" + }, + { + "type": "string", + "name": "mergeable_state", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "merged_by", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "integer", + "name": "comments", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "review_comments", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintainer_can_modify", + "description": "

Indicates whether maintainers can modify the pull request.

", + "isRequired": true + }, + { + "type": "integer", + "name": "commits", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "additions", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "deletions", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "changed_files", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "childParamsGroups": [] + } + ], + "availability": [ + "app" + ], + "action": "requested", + "category": "deployment_protection_rule" + } + }, "deployment_status": { "created": { "descriptionHtml": "

A new deployment status was created.

", diff --git a/src/webhooks/data/ghec/schema.json b/src/webhooks/data/ghec/schema.json index 968bc46cd860..7b1a9bf9b0cf 100644 --- a/src/webhooks/data/ghec/schema.json +++ b/src/webhooks/data/ghec/schema.json @@ -21202,6 +21202,3745 @@ "category": "deployment" } }, + "deployment_protection_rule": { + "requested": { + "descriptionHtml": "

A deployment protection rule was requested for an environment.

", + "summaryHtml": "

This event occurs when there is activity relating to deployment protection rules. For more information, see \"Using environments for deployment.\" For information about the API to manage deployment protection rules, see the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "enum": [ + "requested" + ], + "childParamsGroups": [] + }, + { + "type": "string", + "name": "environment", + "in": "body", + "description": "

The name of the environment that has the deployment protection rule.

" + }, + { + "type": "string", + "name": "event", + "in": "body", + "description": "

The event that triggered the deployment protection rule.

" + }, + { + "type": "string", + "name": "deployment_callback_url", + "in": "body", + "description": "

The URL to review the deployment protection rule.

" + }, + { + "type": "object", + "name": "deployment", + "in": "body", + "description": "

A request for a specific ref(branch,sha,tag) to be deployed

", + "childParamsGroups": [ + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "

Unique identifier of the deployment

", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "description": "

The ref to deploy. This can be a branch, tag, or sha.

", + "isRequired": true + }, + { + "type": "string", + "name": "task", + "description": "

Parameter to specify a task to execute

", + "isRequired": true + }, + { + "type": "object or string", + "name": "payload", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "original_environment", + "description": "" + }, + { + "type": "string", + "name": "environment", + "description": "

Name for the target deployment environment.

", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "creator", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "statuses_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "transient_environment", + "description": "

Specifies if the given environment is will no longer exist at some point in the future. Default: false.

" + }, + { + "type": "boolean", + "name": "production_environment", + "description": "

Specifies if the given environment is one that end-users directly interact with. Default: false.

" + }, + { + "type": "object", + "name": "performed_via_github_app", + "description": "

GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.

", + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "

Unique identifier of the GitHub app

", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "

The slug name of the GitHub app

" + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "owner", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string", + "name": "name", + "description": "

The name of the GitHub app

", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "external_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "permissions", + "description": "

The set of permissions for the GitHub app

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "issues", + "description": "" + }, + { + "type": "string", + "name": "checks", + "description": "" + }, + { + "type": "string", + "name": "metadata", + "description": "" + }, + { + "type": "string", + "name": "contents", + "description": "" + }, + { + "type": "string", + "name": "deployments", + "description": "" + } + ] + }, + { + "type": "array of strings", + "name": "events", + "description": "

The list of events for the GitHub app

", + "isRequired": true + }, + { + "type": "integer", + "name": "installations_count", + "description": "

The number of installations associated with the GitHub app

" + }, + { + "type": "string", + "name": "client_id", + "description": "" + }, + { + "type": "string", + "name": "client_secret", + "description": "" + }, + { + "type": "string or null", + "name": "webhook_secret", + "description": "" + }, + { + "type": "string", + "name": "pem", + "description": "" + } + ] + } + ] + }, + { + "type": "array of objects", + "name": "pull_requests", + "in": "body", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "diff_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "patch_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "review_comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "review_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "statuses_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "

Number uniquely identifying the pull request within its repository.

", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "

State of this Pull Request. Either open or closed.

", + "isRequired": true, + "enum": [ + "open", + "closed" + ] + }, + { + "type": "boolean", + "name": "locked", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "title", + "description": "

The title of the pull request.

", + "isRequired": true + }, + { + "type": "object", + "name": "user", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "body", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "labels", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "color", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "default", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "milestone", + "description": "

A collection of related issues and pull requests.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "

The number of the milestone.

", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "

The state of the milestone.

", + "isRequired": true, + "enum": [ + "open", + "closed" + ], + "default": "open" + }, + { + "type": "string", + "name": "title", + "description": "

The title of the milestone.

", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "creator", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "closed_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "due_on", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string or null", + "name": "active_lock_reason", + "description": "" + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "merged_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "merge_commit_sha", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "assignee", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "array of objects or null", + "name": "assignees", + "description": "", + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "array of objects or null", + "name": "requested_reviewers", + "description": "", + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "array of objects or null", + "name": "requested_teams", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "

Unique identifier of the team

", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "

URL for the team

", + "isRequired": true + }, + { + "type": "string", + "name": "members_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

Name of the team

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

Description of the team

", + "isRequired": true + }, + { + "type": "string", + "name": "permission", + "description": "

Permission that the team will have for its repositories

", + "isRequired": true + }, + { + "type": "string", + "name": "privacy", + "description": "

The level of privacy this team should have

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

The notification setting the team has set

" + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repositories_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ldap_dn", + "description": "

Distinguished Name (DN) that team maps to within LDAP environment

" + } + ] + }, + { + "type": "object", + "name": "head", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "label", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "repo", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "archive_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "assignees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "blobs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "branches_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "collaborators_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "compare_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contents_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contributors_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "deployments_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "downloads_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "fork", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "forks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_refs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "hooks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issues_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "keys_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "languages_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "merges_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "milestones_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "notifications_url", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "pulls_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "releases_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "stargazers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "statuses_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscribers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscription_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "teams_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "trees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "clone_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "default_branch", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_downloads", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_issues", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_projects", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_wiki", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_pages", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_discussions", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "homepage", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "language", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "master_branch", + "description": "" + }, + { + "type": "boolean", + "name": "archived", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "disabled", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "visibility", + "description": "

The repository visibility: public, private, or internal.

" + }, + { + "type": "string or null", + "name": "mirror_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues_count", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "permissions", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "admin", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintain", + "description": "" + }, + { + "type": "boolean", + "name": "push", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "triage", + "description": "" + }, + { + "type": "boolean", + "name": "pull", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "temp_clone_token", + "description": "" + }, + { + "type": "boolean", + "name": "allow_merge_commit", + "description": "" + }, + { + "type": "boolean", + "name": "allow_squash_merge", + "description": "" + }, + { + "type": "boolean", + "name": "allow_rebase_merge", + "description": "" + }, + { + "type": "object or null", + "name": "license", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "spdx_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "pushed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "size", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ssh_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "stargazers_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "svn_url", + "description": "", + "isRequired": true + }, + { + "type": "array of strings", + "name": "topics", + "description": "" + }, + { + "type": "integer", + "name": "watchers", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "watchers_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "allow_forking", + "description": "" + }, + { + "type": "boolean", + "name": "is_template", + "description": "" + }, + { + "type": "boolean", + "name": "web_commit_signoff_required", + "description": "" + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + } + ] + }, + { + "type": "object", + "name": "base", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "label", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "archive_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "assignees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "blobs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "branches_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "collaborators_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "compare_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contents_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contributors_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "deployments_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "downloads_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "fork", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "forks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_refs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "hooks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_template", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issues_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "keys_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "languages_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "merges_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "milestones_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "notifications_url", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "pulls_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "releases_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "stargazers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "statuses_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscribers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscription_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "teams_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "trees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "clone_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "default_branch", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_downloads", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_issues", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_projects", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_wiki", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_pages", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_discussions", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "homepage", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "language", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "master_branch", + "description": "" + }, + { + "type": "boolean", + "name": "archived", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "disabled", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "visibility", + "description": "

The repository visibility: public, private, or internal.

" + }, + { + "type": "string or null", + "name": "mirror_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues_count", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "permissions", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "admin", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintain", + "description": "" + }, + { + "type": "boolean", + "name": "push", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "triage", + "description": "" + }, + { + "type": "boolean", + "name": "pull", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "temp_clone_token", + "description": "" + }, + { + "type": "boolean", + "name": "allow_merge_commit", + "description": "" + }, + { + "type": "boolean", + "name": "allow_squash_merge", + "description": "" + }, + { + "type": "boolean", + "name": "allow_rebase_merge", + "description": "" + }, + { + "type": "object", + "name": "license", + "description": "

License Simple

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "spdx_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "" + } + ] + }, + { + "type": "string", + "name": "pushed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "size", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ssh_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "stargazers_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "svn_url", + "description": "", + "isRequired": true + }, + { + "type": "array of strings", + "name": "topics", + "description": "" + }, + { + "type": "integer", + "name": "watchers", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "watchers_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "allow_forking", + "description": "" + }, + { + "type": "boolean", + "name": "web_commit_signoff_required", + "description": "" + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + } + ] + }, + { + "type": "object", + "name": "_links", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "comments", + "description": "

Hypermedia Link

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "commits", + "description": "

Hypermedia Link

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "statuses", + "description": "

Hypermedia Link

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "html", + "description": "

Hypermedia Link

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "issue", + "description": "

Hypermedia Link

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "review_comments", + "description": "

Hypermedia Link

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "review_comment", + "description": "

Hypermedia Link

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "self", + "description": "

Hypermedia Link

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + } + ] + }, + { + "type": "string", + "name": "author_association", + "description": "

How the author is associated with the repository.

", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "object or null", + "name": "auto_merge", + "description": "

The status of auto merging a pull request.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "enabled_by", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string", + "name": "merge_method", + "description": "

The merge method to use.

", + "isRequired": true, + "enum": [ + "merge", + "squash", + "rebase" + ] + }, + { + "type": "string", + "name": "commit_title", + "description": "

Title for the merge commit message.

", + "isRequired": true + }, + { + "type": "string", + "name": "commit_message", + "description": "

Commit message for the merge commit.

", + "isRequired": true + } + ] + }, + { + "type": "boolean", + "name": "draft", + "description": "

Indicates whether or not the pull request is a draft.

" + }, + { + "type": "boolean", + "name": "merged", + "description": "", + "isRequired": true + }, + { + "type": "boolean or null", + "name": "mergeable", + "description": "", + "isRequired": true + }, + { + "type": "boolean or null", + "name": "rebaseable", + "description": "" + }, + { + "type": "string", + "name": "mergeable_state", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "merged_by", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "integer", + "name": "comments", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "review_comments", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintainer_can_modify", + "description": "

Indicates whether maintainers can modify the pull request.

", + "isRequired": true + }, + { + "type": "integer", + "name": "commits", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "additions", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "deletions", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "changed_files", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "childParamsGroups": [] + } + ], + "availability": [ + "app" + ], + "action": "requested", + "category": "deployment_protection_rule" + } + }, "deployment_status": { "created": { "descriptionHtml": "

A new deployment status was created.

", diff --git a/src/webhooks/lib/config.json b/src/webhooks/lib/config.json index 9a98288a9698..01e3f5247f3f 100644 --- a/src/webhooks/lib/config.json +++ b/src/webhooks/lib/config.json @@ -1,3 +1,3 @@ { - "sha": "955d6a6a61c413f2940b977647300f1c609b0ec6" + "sha": "cf133481cb255f2119fe875dcfde3e047d2017b7" } \ No newline at end of file