From 8042b3f2068e5554521596853252827a2f203000 Mon Sep 17 00:00:00 2001 From: Octokit Bot <33075676+octokitbot@users.noreply.github.com> Date: Fri, 28 Apr 2023 18:14:36 +0000 Subject: [PATCH] WIP octokit/openapi updated --- package-lock.json | 30 +-- package.json | 2 +- .../update-endpoints/generated/endpoints.json | 191 ++++++------------ 3 files changed, 73 insertions(+), 150 deletions(-) diff --git a/package-lock.json b/package-lock.json index 816c3efc..4b982313 100644 --- a/package-lock.json +++ b/package-lock.json @@ -9,7 +9,7 @@ "version": "0.0.0-development", "license": "MIT", "dependencies": { - "@octokit/types": "^9.1.4" + "@octokit/types": "^9.2.0" }, "devDependencies": { "@octokit/core": "^4.0.0", @@ -2675,9 +2675,9 @@ } }, "node_modules/@octokit/openapi-types": { - "version": "17.0.0", - "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-17.0.0.tgz", - "integrity": "sha512-V8BVJGN0ZmMlURF55VFHFd/L92XQQ43KvFjNmY1IYbCN3V/h/uUFV6iQi19WEHM395Nn+1qhUbViCAD/1czzog==" + "version": "17.1.0", + "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-17.1.0.tgz", + "integrity": "sha512-rnI26BAITDZTo5vqFOmA7oX4xRd18rO+gcK4MiTpJmsRMxAw0JmevNjPsjpry1bb9SVNo56P/0kbiyXXa4QluA==" }, "node_modules/@octokit/plugin-rest-endpoint-methods": { "version": "7.0.1", @@ -2727,11 +2727,11 @@ } }, "node_modules/@octokit/types": { - "version": "9.1.4", - "resolved": "https://registry.npmjs.org/@octokit/types/-/types-9.1.4.tgz", - "integrity": "sha512-5d9vYHzC/yG9eyYBO2Pis4BM4tQfFcyFUWBquDgCzcmFG+sgBiRQ2JCY55HG/hdxvESt9IZUoRtzOm66Qv/GWw==", + "version": "9.2.0", + "resolved": "https://registry.npmjs.org/@octokit/types/-/types-9.2.0.tgz", + "integrity": "sha512-xySzJG4noWrIBFyMu4lg4tu9vAgNg9S0aoLRONhAEz6ueyi1evBzb40HitIosaYS4XOexphG305IVcLrIX/30g==", "dependencies": { - "@octokit/openapi-types": "^17.0.0" + "@octokit/openapi-types": "^17.1.0" } }, "node_modules/@pika/babel-plugin-esm-import-rewrite": { @@ -11183,9 +11183,9 @@ } }, "@octokit/openapi-types": { - "version": "17.0.0", - "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-17.0.0.tgz", - "integrity": "sha512-V8BVJGN0ZmMlURF55VFHFd/L92XQQ43KvFjNmY1IYbCN3V/h/uUFV6iQi19WEHM395Nn+1qhUbViCAD/1czzog==" + "version": "17.1.0", + "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-17.1.0.tgz", + "integrity": "sha512-rnI26BAITDZTo5vqFOmA7oX4xRd18rO+gcK4MiTpJmsRMxAw0JmevNjPsjpry1bb9SVNo56P/0kbiyXXa4QluA==" }, "@octokit/plugin-rest-endpoint-methods": { "version": "7.0.1", @@ -11223,11 +11223,11 @@ } }, "@octokit/types": { - "version": "9.1.4", - "resolved": "https://registry.npmjs.org/@octokit/types/-/types-9.1.4.tgz", - "integrity": "sha512-5d9vYHzC/yG9eyYBO2Pis4BM4tQfFcyFUWBquDgCzcmFG+sgBiRQ2JCY55HG/hdxvESt9IZUoRtzOm66Qv/GWw==", + "version": "9.2.0", + "resolved": "https://registry.npmjs.org/@octokit/types/-/types-9.2.0.tgz", + "integrity": "sha512-xySzJG4noWrIBFyMu4lg4tu9vAgNg9S0aoLRONhAEz6ueyi1evBzb40HitIosaYS4XOexphG305IVcLrIX/30g==", "requires": { - "@octokit/openapi-types": "^17.0.0" + "@octokit/openapi-types": "^17.1.0" } }, "@pika/babel-plugin-esm-import-rewrite": { diff --git a/package.json b/package.json index 483bd465..53c66a33 100644 --- a/package.json +++ b/package.json @@ -25,7 +25,7 @@ ], "license": "MIT", "dependencies": { - "@octokit/types": "^9.1.4" + "@octokit/types": "^9.2.0" }, "peerDependencies": { "@octokit/core": ">=4" diff --git a/scripts/update-endpoints/generated/endpoints.json b/scripts/update-endpoints/generated/endpoints.json index f73d7816..3ec7c67a 100644 --- a/scripts/update-endpoints/generated/endpoints.json +++ b/scripts/update-endpoints/generated/endpoints.json @@ -10257,89 +10257,6 @@ ], "parameters": [{ "name": "org" }, { "name": "hook_id" }] }, - { - "url": "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts", - "id": "redeliver-webhook-delivery", - "scope": "orgs", - "documentationUrl": "https://docs.github.com/rest/reference/orgs#list-security-manager-teams", - "renamed": null, - "responses": [ - { - "code": 200, - "schema": "{\"type\":\"array\",\"items\":{\"title\":\"Team Simple\",\"description\":\"Groups of organization members that gives permissions on specified repositories.\",\"type\":\"object\",\"properties\":{\"id\":{\"description\":\"Unique identifier of the team\",\"type\":\"integer\",\"example\":1},\"node_id\":{\"type\":\"string\",\"example\":\"MDQ6VGVhbTE=\"},\"url\":{\"description\":\"URL for the team\",\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/organizations/1/team/1\"},\"members_url\":{\"type\":\"string\",\"example\":\"https://api.github.com/organizations/1/team/1/members{/member}\"},\"name\":{\"description\":\"Name of the team\",\"type\":\"string\",\"example\":\"Justice League\"},\"description\":{\"description\":\"Description of the team\",\"type\":\"string\",\"nullable\":true,\"example\":\"A great team.\"},\"permission\":{\"description\":\"Permission that the team will have for its repositories\",\"type\":\"string\",\"example\":\"admin\"},\"privacy\":{\"description\":\"The level of privacy this team should have\",\"type\":\"string\",\"example\":\"closed\"},\"notification_setting\":{\"description\":\"The notification setting the team has set\",\"type\":\"string\",\"example\":\"notifications_enabled\"},\"html_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://github.com/orgs/rails/teams/core\"},\"repositories_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/organizations/1/team/1/repos\"},\"slug\":{\"type\":\"string\",\"example\":\"justice-league\"},\"ldap_dn\":{\"description\":\"Distinguished Name (DN) that team maps to within LDAP environment\",\"example\":\"uid=example,ou=users,dc=github,dc=com\",\"type\":\"string\"}},\"required\":[\"id\",\"node_id\",\"url\",\"members_url\",\"name\",\"description\",\"permission\",\"html_url\",\"repositories_url\",\"slug\"]}}" - } - ], - "parameters": [{ "name": "org" }] - }, - { - "url": "/orgs/{org}/hooks/{hook_id}/deliveries", - "id": "list-webhook-deliveries", - "scope": "orgs", - "documentationUrl": "https://docs.github.com/rest/reference/orgs#list-deliveries-for-an-organization-webhook", - "renamed": null, - "responses": [ - { - "code": 200, - "schema": "{\"type\":\"array\",\"items\":{\"title\":\"Simple webhook delivery\",\"description\":\"Delivery made by a webhook, without request and response information.\",\"type\":\"object\",\"properties\":{\"id\":{\"description\":\"Unique identifier of the webhook delivery.\",\"type\":\"integer\",\"example\":42},\"guid\":{\"description\":\"Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event).\",\"type\":\"string\",\"example\":\"58474f00-b361-11eb-836d-0e4f3503ccbe\"},\"delivered_at\":{\"description\":\"Time when the webhook delivery occurred.\",\"type\":\"string\",\"format\":\"date-time\",\"example\":\"2021-05-12T20:33:44Z\"},\"redelivery\":{\"description\":\"Whether the webhook delivery is a redelivery.\",\"type\":\"boolean\",\"example\":false},\"duration\":{\"description\":\"Time spent delivering.\",\"type\":\"number\",\"example\":0.03},\"status\":{\"description\":\"Describes the response returned after attempting the delivery.\",\"type\":\"string\",\"example\":\"failed to connect\"},\"status_code\":{\"description\":\"Status code received when delivery was made.\",\"type\":\"integer\",\"example\":502},\"event\":{\"description\":\"The event that triggered the delivery.\",\"type\":\"string\",\"example\":\"issues\"},\"action\":{\"description\":\"The type of activity for the event that triggered the delivery.\",\"type\":\"string\",\"example\":\"opened\",\"nullable\":true},\"installation_id\":{\"description\":\"The id of the GitHub App installation associated with this event.\",\"type\":\"integer\",\"example\":123,\"nullable\":true},\"repository_id\":{\"description\":\"The id of the repository associated with this event.\",\"type\":\"integer\",\"example\":123,\"nullable\":true}},\"required\":[\"id\",\"guid\",\"delivered_at\",\"redelivery\",\"duration\",\"status\",\"status_code\",\"event\",\"action\",\"installation_id\",\"repository_id\"]}}" - }, - { - "code": 400, - "schema": "{\"title\":\"Basic Error\",\"description\":\"Basic Error\",\"type\":\"object\",\"properties\":{\"message\":{\"type\":\"string\"},\"documentation_url\":{\"type\":\"string\"},\"url\":{\"type\":\"string\"},\"status\":{\"type\":\"string\"}}}" - }, - { - "code": 400, - "schema": "{\"title\":\"Scim Error\",\"description\":\"Scim Error\",\"type\":\"object\",\"properties\":{\"message\":{\"type\":\"string\",\"nullable\":true},\"documentation_url\":{\"type\":\"string\",\"nullable\":true},\"detail\":{\"type\":\"string\",\"nullable\":true},\"status\":{\"type\":\"integer\"},\"scimType\":{\"type\":\"string\",\"nullable\":true},\"schemas\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}}}}" - }, - { - "code": 422, - "schema": "{\"title\":\"Validation Error\",\"description\":\"Validation Error\",\"type\":\"object\",\"required\":[\"message\",\"documentation_url\"],\"properties\":{\"message\":{\"type\":\"string\"},\"documentation_url\":{\"type\":\"string\"},\"errors\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"required\":[\"code\"],\"properties\":{\"resource\":{\"type\":\"string\"},\"field\":{\"type\":\"string\"},\"message\":{\"type\":\"string\"},\"code\":{\"type\":\"string\"},\"index\":{\"type\":\"integer\"},\"value\":{\"oneOf\":[{\"type\":\"string\",\"nullable\":true},{\"type\":\"integer\",\"nullable\":true},{\"type\":\"array\",\"nullable\":true,\"items\":{\"type\":\"string\"}}]}}}}}}" - } - ], - "parameters": [ - { "name": "org" }, - { "name": "hook_id" }, - { "name": "per_page" }, - { "name": "cursor" }, - { "name": "redelivery" } - ] - }, - { - "url": "/orgs/{org}/hooks", - "id": "list-webhooks", - "scope": "orgs", - "documentationUrl": "https://docs.github.com/rest/reference/orgs#list-organization-webhooks", - "renamed": null, - "responses": [ - { - "code": 200, - "schema": "{\"type\":\"array\",\"items\":{\"title\":\"Org Hook\",\"description\":\"Org Hook\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"integer\",\"example\":1},\"url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/orgs/octocat/hooks/1\"},\"ping_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/orgs/octocat/hooks/1/pings\"},\"deliveries_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/orgs/octocat/hooks/1/deliveries\"},\"name\":{\"type\":\"string\",\"example\":\"web\"},\"events\":{\"type\":\"array\",\"example\":[\"push\",\"pull_request\"],\"items\":{\"type\":\"string\"}},\"active\":{\"type\":\"boolean\",\"example\":true},\"config\":{\"type\":\"object\",\"properties\":{\"url\":{\"type\":\"string\",\"example\":\"\\\"http://example.com/2\\\"\"},\"insecure_ssl\":{\"type\":\"string\",\"example\":\"\\\"0\\\"\"},\"content_type\":{\"type\":\"string\",\"example\":\"\\\"form\\\"\"},\"secret\":{\"type\":\"string\",\"example\":\"\\\"********\\\"\"}}},\"updated_at\":{\"type\":\"string\",\"format\":\"date-time\",\"example\":\"2011-09-06T20:39:23Z\"},\"created_at\":{\"type\":\"string\",\"format\":\"date-time\",\"example\":\"2011-09-06T17:26:27Z\"},\"type\":{\"type\":\"string\"}},\"required\":[\"id\",\"url\",\"type\",\"name\",\"active\",\"events\",\"config\",\"ping_url\",\"created_at\",\"updated_at\"]}}" - }, - { - "code": 404, - "schema": "{\"title\":\"Basic Error\",\"description\":\"Basic Error\",\"type\":\"object\",\"properties\":{\"message\":{\"type\":\"string\"},\"documentation_url\":{\"type\":\"string\"},\"url\":{\"type\":\"string\"},\"status\":{\"type\":\"string\"}}}" - } - ], - "parameters": [ - { "name": "org" }, - { "name": "per_page" }, - { "name": "page" } - ] - }, - { - "url": "/orgs/{org}/hooks/{hook_id}/pings", - "id": "ping-webhook", - "scope": "orgs", - "documentationUrl": "https://docs.github.com/rest/reference/orgs#ping-an-organization-webhook", - "renamed": null, - "responses": [ - { "code": 204, "schema": null }, - { - "code": 404, - "schema": "{\"title\":\"Basic Error\",\"description\":\"Basic Error\",\"type\":\"object\",\"properties\":{\"message\":{\"type\":\"string\"},\"documentation_url\":{\"type\":\"string\"},\"url\":{\"type\":\"string\"},\"status\":{\"type\":\"string\"}}}" - } - ], - "parameters": [{ "name": "org" }, { "name": "hook_id" }] - }, { "url": "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts", "id": "redeliver-webhook-delivery", @@ -14275,55 +14192,6 @@ { "name": "rules[].parameters.pattern" } ] }, - { - "url": "/repos/{owner}/{repo}/pages/deployment", - "id": "create-pages-deployment", - "scope": "repos", - "documentationUrl": "https://docs.github.com/rest/repos/rules#create-organization-repository-ruleset", - "renamed": null, - "responses": [ - { - "code": 201, - "schema": "{\"title\":\"Repository ruleset\",\"type\":\"object\",\"description\":\"A set of rules to apply when specified conditions are met.\",\"required\":[\"id\",\"name\",\"source\",\"enforcement\"],\"properties\":{\"id\":{\"type\":\"integer\",\"description\":\"The ID of the ruleset\"},\"name\":{\"type\":\"string\",\"description\":\"The name of the ruleset\"},\"target\":{\"type\":\"string\",\"description\":\"The target of the ruleset\",\"enum\":[\"branch\",\"tag\"]},\"source_type\":{\"type\":\"string\",\"description\":\"The type of the source of the ruleset\",\"enum\":[\"Repository\",\"Organization\"]},\"source\":{\"type\":\"string\",\"description\":\"The name of the source\"},\"enforcement\":{\"type\":\"string\",\"description\":\"The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise).\",\"enum\":[\"disabled\",\"active\",\"evaluate\"]},\"bypass_mode\":{\"type\":\"string\",\"description\":\"The permission level required to bypass this ruleset. \\\"repository\\\" allows those with bypass permission at the repository level to bypass. \\\"organization\\\" allows those with bypass permission at the organization level to bypass. \\\"none\\\" prevents anyone from bypassing.\",\"enum\":[\"none\",\"repository\",\"organization\"]},\"bypass_actors\":{\"type\":\"array\",\"description\":\"The actors that can bypass the rules in this ruleset\",\"items\":{\"title\":\"Repository Ruleset Bypass Actor\",\"type\":\"object\",\"description\":\"An actor that can bypass rules in a ruleset\",\"properties\":{\"actor_id\":{\"type\":\"integer\",\"description\":\"The ID of the actor that can bypass a ruleset\"},\"actor_type\":{\"type\":\"string\",\"enum\":[\"Team\",\"Integration\"],\"description\":\"The type of actor that can bypass a ruleset\"}}}},\"node_id\":{\"type\":\"string\"},\"_links\":{\"type\":\"object\",\"properties\":{\"self\":{\"type\":\"object\",\"properties\":{\"href\":{\"type\":\"string\",\"description\":\"The URL of the ruleset\"}}}}},\"conditions\":{\"anyOf\":[{\"title\":\"Repository ruleset conditions for ref names\",\"type\":\"object\",\"description\":\"Parameters for a repository ruleset ref name condition\",\"properties\":{\"ref_name\":{\"type\":\"object\",\"properties\":{\"include\":{\"type\":\"array\",\"description\":\"Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.\",\"items\":{\"type\":\"string\"}},\"exclude\":{\"type\":\"array\",\"description\":\"Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.\",\"items\":{\"type\":\"string\"}}}}}},{\"title\":\"Organization ruleset conditions\",\"type\":\"object\",\"description\":\"Conditions for a organization ruleset\",\"allOf\":[{\"title\":\"Repository ruleset conditions for ref names\",\"type\":\"object\",\"description\":\"Parameters for a repository ruleset ref name condition\",\"properties\":{\"ref_name\":{\"type\":\"object\",\"properties\":{\"include\":{\"type\":\"array\",\"description\":\"Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.\",\"items\":{\"type\":\"string\"}},\"exclude\":{\"type\":\"array\",\"description\":\"Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.\",\"items\":{\"type\":\"string\"}}}}}},{\"title\":\"Repository ruleset conditions for repository names\",\"type\":\"object\",\"description\":\"Parameters for a repository name condition\",\"properties\":{\"repository_name\":{\"type\":\"object\",\"properties\":{\"include\":{\"type\":\"array\",\"description\":\"Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.\",\"items\":{\"type\":\"string\"}},\"exclude\":{\"type\":\"array\",\"description\":\"Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.\",\"items\":{\"type\":\"string\"}},\"protected\":{\"type\":\"boolean\",\"description\":\"Whether renaming of target repositories is prevented.\"}}}}}]}]},\"rules\":{\"type\":\"array\",\"items\":{\"title\":\"Repository Rule\",\"type\":\"object\",\"description\":\"A repository rule.\",\"oneOf\":[{\"title\":\"creation\",\"description\":\"Parameters to be used for the creation rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"creation\"]}}},{\"title\":\"update\",\"description\":\"Parameters to be used for the update rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"update\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"update_allows_fetch_and_merge\":{\"type\":\"boolean\",\"description\":\"Branch can pull changes from its upstream repository\"}},\"required\":[\"update_allows_fetch_and_merge\"]}}},{\"title\":\"deletion\",\"description\":\"Parameters to be used for the deletion rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"deletion\"]}}},{\"title\":\"required_linear_history\",\"description\":\"Parameters to be used for the required_linear_history rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"required_linear_history\"]}}},{\"title\":\"required_deployments\",\"description\":\"Parameters to be used for the required_deployments rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"required_deployments\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"required_deployment_environments\":{\"type\":\"array\",\"description\":\"The environments that must be successfully deployed to before branches can be merged.\",\"items\":{\"type\":\"string\"}}},\"required\":[\"required_deployment_environments\"]}}},{\"title\":\"required_signatures\",\"description\":\"Parameters to be used for the required_signatures rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"required_signatures\"]}}},{\"title\":\"pull_request\",\"description\":\"Parameters to be used for the pull_request rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"pull_request\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"dismiss_stale_reviews_on_push\":{\"type\":\"boolean\",\"description\":\"New, reviewable commits pushed will dismiss previous pull request review approvals.\"},\"require_code_owner_review\":{\"type\":\"boolean\",\"description\":\"Require an approving review in pull requests that modify files that have a designated code owner.\"},\"require_last_push_approval\":{\"type\":\"boolean\",\"description\":\"Whether the most recent reviewable push must be approved by someone other than the person who pushed it.\"},\"required_approving_review_count\":{\"type\":\"integer\",\"description\":\"The number of approving reviews that are required before a pull request can be merged.\",\"minimum\":0,\"maximum\":10},\"required_review_thread_resolution\":{\"type\":\"boolean\",\"description\":\"All conversations on code must be resolved before a pull request can be merged.\"}},\"required\":[\"dismiss_stale_reviews_on_push\",\"require_code_owner_review\",\"require_last_push_approval\",\"required_approving_review_count\",\"required_review_thread_resolution\"]}}},{\"title\":\"required_status_checks\",\"description\":\"Parameters to be used for the required_status_checks rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"required_status_checks\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"required_status_checks\":{\"type\":\"array\",\"description\":\"Status checks that are required.\",\"items\":{\"title\":\"StatusCheckConfiguration\",\"description\":\"Required status check\",\"type\":\"object\",\"properties\":{\"context\":{\"type\":\"string\",\"description\":\"The status check context name that must be present on the commit.\"},\"integration_id\":{\"type\":\"integer\",\"description\":\"The optional integration ID that this status check must originate from.\"}},\"required\":[\"context\"]}},\"strict_required_status_checks_policy\":{\"type\":\"boolean\",\"description\":\"Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled.\"}},\"required\":[\"required_status_checks\",\"strict_required_status_checks_policy\"]}}},{\"title\":\"non_fast_forward\",\"description\":\"Parameters to be used for the non_fast_forward rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"non_fast_forward\"]}}},{\"title\":\"commit_message_pattern\",\"description\":\"Parameters to be used for the commit_message_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"commit_message_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}},{\"title\":\"commit_author_email_pattern\",\"description\":\"Parameters to be used for the commit_author_email_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"commit_author_email_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}},{\"title\":\"committer_email_pattern\",\"description\":\"Parameters to be used for the committer_email_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"committer_email_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}},{\"title\":\"branch_name_pattern\",\"description\":\"Parameters to be used for the branch_name_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"branch_name_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}},{\"title\":\"tag_name_pattern\",\"description\":\"Parameters to be used for the tag_name_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"tag_name_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}}]}}}}" - }, - { - "code": 404, - "schema": "{\"title\":\"Basic Error\",\"description\":\"Basic Error\",\"type\":\"object\",\"properties\":{\"message\":{\"type\":\"string\"},\"documentation_url\":{\"type\":\"string\"},\"url\":{\"type\":\"string\"},\"status\":{\"type\":\"string\"}}}" - }, - { - "code": 500, - "schema": "{\"title\":\"Basic Error\",\"description\":\"Basic Error\",\"type\":\"object\",\"properties\":{\"message\":{\"type\":\"string\"},\"documentation_url\":{\"type\":\"string\"},\"url\":{\"type\":\"string\"},\"status\":{\"type\":\"string\"}}}" - } - ], - "parameters": [ - { "name": "org" }, - { "name": "name" }, - { "name": "target" }, - { "name": "enforcement" }, - { "name": "bypass_actors" }, - { "name": "bypass_actors[].actor_id" }, - { "name": "bypass_actors[].actor_type" }, - { "name": "conditions" }, - { "name": "rules" }, - { "name": "rules[].type" }, - { "name": "rules[].parameters" }, - { "name": "rules[].parameters.update_allows_fetch_and_merge" }, - { "name": "rules[].parameters.required_deployment_environments" }, - { "name": "rules[].parameters.dismiss_stale_reviews_on_push" }, - { "name": "rules[].parameters.require_code_owner_review" }, - { "name": "rules[].parameters.require_last_push_approval" }, - { "name": "rules[].parameters.required_approving_review_count" }, - { "name": "rules[].parameters.required_review_thread_resolution" }, - { "name": "rules[].parameters.required_status_checks" }, - { "name": "rules[].parameters.required_status_checks[].context" }, - { "name": "rules[].parameters.required_status_checks[].integration_id" }, - { "name": "rules[].parameters.strict_required_status_checks_policy" }, - { "name": "rules[].parameters.name" }, - { "name": "rules[].parameters.negate" }, - { "name": "rules[].parameters.operator" }, - { "name": "rules[].parameters.pattern" } - ] - }, { "url": "/repos/{owner}/{repo}/pages/deployment", "id": "create-pages-deployment", @@ -17880,6 +17748,61 @@ { "name": "rules[].parameters.pattern" } ] }, + { + "url": "/repos/{owner}/{repo}/rulesets/{ruleset_id}", + "id": "update-repo-ruleset", + "scope": "repos", + "documentationUrl": "https://docs.github.com/rest/repos/rules#update-repository-ruleset", + "renamed": null, + "responses": [ + { + "code": 200, + "schema": "{\"title\":\"Repository ruleset\",\"type\":\"object\",\"description\":\"A set of rules to apply when specified conditions are met.\",\"required\":[\"id\",\"name\",\"source\",\"enforcement\"],\"properties\":{\"id\":{\"type\":\"integer\",\"description\":\"The ID of the ruleset\"},\"name\":{\"type\":\"string\",\"description\":\"The name of the ruleset\"},\"target\":{\"type\":\"string\",\"description\":\"The target of the ruleset\",\"enum\":[\"branch\",\"tag\"]},\"source_type\":{\"type\":\"string\",\"description\":\"The type of the source of the ruleset\",\"enum\":[\"Repository\",\"Organization\"]},\"source\":{\"type\":\"string\",\"description\":\"The name of the source\"},\"enforcement\":{\"type\":\"string\",\"description\":\"The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise).\",\"enum\":[\"disabled\",\"active\",\"evaluate\"]},\"bypass_mode\":{\"type\":\"string\",\"description\":\"The permission level required to bypass this ruleset. \\\"repository\\\" allows those with bypass permission at the repository level to bypass. \\\"organization\\\" allows those with bypass permission at the organization level to bypass. \\\"none\\\" prevents anyone from bypassing.\",\"enum\":[\"none\",\"repository\",\"organization\"]},\"bypass_actors\":{\"type\":\"array\",\"description\":\"The actors that can bypass the rules in this ruleset\",\"items\":{\"title\":\"Repository Ruleset Bypass Actor\",\"type\":\"object\",\"description\":\"An actor that can bypass rules in a ruleset\",\"properties\":{\"actor_id\":{\"type\":\"integer\",\"description\":\"The ID of the actor that can bypass a ruleset\"},\"actor_type\":{\"type\":\"string\",\"enum\":[\"Team\",\"Integration\"],\"description\":\"The type of actor that can bypass a ruleset\"}}}},\"node_id\":{\"type\":\"string\"},\"_links\":{\"type\":\"object\",\"properties\":{\"self\":{\"type\":\"object\",\"properties\":{\"href\":{\"type\":\"string\",\"description\":\"The URL of the ruleset\"}}}}},\"conditions\":{\"anyOf\":[{\"title\":\"Repository ruleset conditions for ref names\",\"type\":\"object\",\"description\":\"Parameters for a repository ruleset ref name condition\",\"properties\":{\"ref_name\":{\"type\":\"object\",\"properties\":{\"include\":{\"type\":\"array\",\"description\":\"Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.\",\"items\":{\"type\":\"string\"}},\"exclude\":{\"type\":\"array\",\"description\":\"Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.\",\"items\":{\"type\":\"string\"}}}}}},{\"title\":\"Organization ruleset conditions\",\"type\":\"object\",\"description\":\"Conditions for a organization ruleset\",\"allOf\":[{\"title\":\"Repository ruleset conditions for ref names\",\"type\":\"object\",\"description\":\"Parameters for a repository ruleset ref name condition\",\"properties\":{\"ref_name\":{\"type\":\"object\",\"properties\":{\"include\":{\"type\":\"array\",\"description\":\"Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.\",\"items\":{\"type\":\"string\"}},\"exclude\":{\"type\":\"array\",\"description\":\"Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.\",\"items\":{\"type\":\"string\"}}}}}},{\"title\":\"Repository ruleset conditions for repository names\",\"type\":\"object\",\"description\":\"Parameters for a repository name condition\",\"properties\":{\"repository_name\":{\"type\":\"object\",\"properties\":{\"include\":{\"type\":\"array\",\"description\":\"Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.\",\"items\":{\"type\":\"string\"}},\"exclude\":{\"type\":\"array\",\"description\":\"Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.\",\"items\":{\"type\":\"string\"}},\"protected\":{\"type\":\"boolean\",\"description\":\"Whether renaming of target repositories is prevented.\"}}}}}]}]},\"rules\":{\"type\":\"array\",\"items\":{\"title\":\"Repository Rule\",\"type\":\"object\",\"description\":\"A repository rule.\",\"oneOf\":[{\"title\":\"creation\",\"description\":\"Parameters to be used for the creation rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"creation\"]}}},{\"title\":\"update\",\"description\":\"Parameters to be used for the update rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"update\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"update_allows_fetch_and_merge\":{\"type\":\"boolean\",\"description\":\"Branch can pull changes from its upstream repository\"}},\"required\":[\"update_allows_fetch_and_merge\"]}}},{\"title\":\"deletion\",\"description\":\"Parameters to be used for the deletion rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"deletion\"]}}},{\"title\":\"required_linear_history\",\"description\":\"Parameters to be used for the required_linear_history rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"required_linear_history\"]}}},{\"title\":\"required_deployments\",\"description\":\"Parameters to be used for the required_deployments rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"required_deployments\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"required_deployment_environments\":{\"type\":\"array\",\"description\":\"The environments that must be successfully deployed to before branches can be merged.\",\"items\":{\"type\":\"string\"}}},\"required\":[\"required_deployment_environments\"]}}},{\"title\":\"required_signatures\",\"description\":\"Parameters to be used for the required_signatures rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"required_signatures\"]}}},{\"title\":\"pull_request\",\"description\":\"Parameters to be used for the pull_request rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"pull_request\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"dismiss_stale_reviews_on_push\":{\"type\":\"boolean\",\"description\":\"New, reviewable commits pushed will dismiss previous pull request review approvals.\"},\"require_code_owner_review\":{\"type\":\"boolean\",\"description\":\"Require an approving review in pull requests that modify files that have a designated code owner.\"},\"require_last_push_approval\":{\"type\":\"boolean\",\"description\":\"Whether the most recent reviewable push must be approved by someone other than the person who pushed it.\"},\"required_approving_review_count\":{\"type\":\"integer\",\"description\":\"The number of approving reviews that are required before a pull request can be merged.\",\"minimum\":0,\"maximum\":10},\"required_review_thread_resolution\":{\"type\":\"boolean\",\"description\":\"All conversations on code must be resolved before a pull request can be merged.\"}},\"required\":[\"dismiss_stale_reviews_on_push\",\"require_code_owner_review\",\"require_last_push_approval\",\"required_approving_review_count\",\"required_review_thread_resolution\"]}}},{\"title\":\"required_status_checks\",\"description\":\"Parameters to be used for the required_status_checks rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"required_status_checks\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"required_status_checks\":{\"type\":\"array\",\"description\":\"Status checks that are required.\",\"items\":{\"title\":\"StatusCheckConfiguration\",\"description\":\"Required status check\",\"type\":\"object\",\"properties\":{\"context\":{\"type\":\"string\",\"description\":\"The status check context name that must be present on the commit.\"},\"integration_id\":{\"type\":\"integer\",\"description\":\"The optional integration ID that this status check must originate from.\"}},\"required\":[\"context\"]}},\"strict_required_status_checks_policy\":{\"type\":\"boolean\",\"description\":\"Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled.\"}},\"required\":[\"required_status_checks\",\"strict_required_status_checks_policy\"]}}},{\"title\":\"non_fast_forward\",\"description\":\"Parameters to be used for the non_fast_forward rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"non_fast_forward\"]}}},{\"title\":\"commit_message_pattern\",\"description\":\"Parameters to be used for the commit_message_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"commit_message_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}},{\"title\":\"commit_author_email_pattern\",\"description\":\"Parameters to be used for the commit_author_email_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"commit_author_email_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}},{\"title\":\"committer_email_pattern\",\"description\":\"Parameters to be used for the committer_email_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"committer_email_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}},{\"title\":\"branch_name_pattern\",\"description\":\"Parameters to be used for the branch_name_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"branch_name_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}},{\"title\":\"tag_name_pattern\",\"description\":\"Parameters to be used for the tag_name_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"tag_name_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}}]}}}}" + }, + { + "code": 404, + "schema": "{\"title\":\"Basic Error\",\"description\":\"Basic Error\",\"type\":\"object\",\"properties\":{\"message\":{\"type\":\"string\"},\"documentation_url\":{\"type\":\"string\"},\"url\":{\"type\":\"string\"},\"status\":{\"type\":\"string\"}}}" + }, + { + "code": 500, + "schema": "{\"title\":\"Basic Error\",\"description\":\"Basic Error\",\"type\":\"object\",\"properties\":{\"message\":{\"type\":\"string\"},\"documentation_url\":{\"type\":\"string\"},\"url\":{\"type\":\"string\"},\"status\":{\"type\":\"string\"}}}" + } + ], + "parameters": [ + { "name": "owner" }, + { "name": "repo" }, + { "name": "ruleset_id" }, + { "name": "name" }, + { "name": "target" }, + { "name": "enforcement" }, + { "name": "bypass_mode" }, + { "name": "bypass_actors" }, + { "name": "bypass_actors[].actor_id" }, + { "name": "bypass_actors[].actor_type" }, + { "name": "conditions" }, + { "name": "conditions.ref_name" }, + { "name": "conditions.ref_name.include" }, + { "name": "conditions.ref_name.exclude" }, + { "name": "rules" }, + { "name": "rules[].type" }, + { "name": "rules[].parameters" }, + { "name": "rules[].parameters.update_allows_fetch_and_merge" }, + { "name": "rules[].parameters.required_deployment_environments" }, + { "name": "rules[].parameters.dismiss_stale_reviews_on_push" }, + { "name": "rules[].parameters.require_code_owner_review" }, + { "name": "rules[].parameters.require_last_push_approval" }, + { "name": "rules[].parameters.required_approving_review_count" }, + { "name": "rules[].parameters.required_review_thread_resolution" }, + { "name": "rules[].parameters.required_status_checks" }, + { "name": "rules[].parameters.required_status_checks[].context" }, + { "name": "rules[].parameters.required_status_checks[].integration_id" }, + { "name": "rules[].parameters.strict_required_status_checks_policy" }, + { "name": "rules[].parameters.name" }, + { "name": "rules[].parameters.negate" }, + { "name": "rules[].parameters.operator" }, + { "name": "rules[].parameters.pattern" } + ] + }, { "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", "id": "update-status-check-potection", @@ -18494,10 +18417,10 @@ }, { "code": 200, - "schema": "{\"type\":\"array\",\"items\":{\"description\":\"A repository security advisory.\",\"type\":\"object\",\"properties\":{\"ghsa_id\":{\"type\":\"string\",\"description\":\"The GitHub Security Advisory ID.\",\"readOnly\":true},\"cve_id\":{\"type\":\"string\",\"description\":\"The Common Vulnerabilities and Exposures (CVE) ID.\",\"nullable\":true},\"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\",\"description\":\"A detailed description of what the advisory entails.\",\"maxLength\":65535,\"nullable\":true},\"severity\":{\"type\":\"string\",\"description\":\"The severity of the advisory.\",\"nullable\":true,\"enum\":[\"critical\",\"high\",\"medium\",\"low\"]},\"author\":{\"readOnly\":true,\"nullable\":true,\"description\":\"The author of the advisory.\",\"allOf\":[{\"title\":\"Simple User\",\"description\":\"A GitHub user.\",\"type\":\"object\",\"properties\":{\"name\":{\"nullable\":true,\"type\":\"string\"},\"email\":{\"nullable\":true,\"type\":\"string\"},\"login\":{\"type\":\"string\",\"example\":\"octocat\"},\"id\":{\"type\":\"integer\",\"example\":1},\"node_id\":{\"type\":\"string\",\"example\":\"MDQ6VXNlcjE=\"},\"avatar_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://github.com/images/error/octocat_happy.gif\"},\"gravatar_id\":{\"type\":\"string\",\"example\":\"41d064eb2195891e12d0413f63227ea7\",\"nullable\":true},\"url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/users/octocat\"},\"html_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://github.com/octocat\"},\"followers_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/users/octocat/followers\"},\"following_url\":{\"type\":\"string\",\"example\":\"https://api.github.com/users/octocat/following{/other_user}\"},\"gists_url\":{\"type\":\"string\",\"example\":\"https://api.github.com/users/octocat/gists{/gist_id}\"},\"starred_url\":{\"type\":\"string\",\"example\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\"},\"subscriptions_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/users/octocat/subscriptions\"},\"organizations_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/users/octocat/orgs\"},\"repos_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/users/octocat/repos\"},\"events_url\":{\"type\":\"string\",\"example\":\"https://api.github.com/users/octocat/events{/privacy}\"},\"received_events_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/users/octocat/received_events\"},\"type\":{\"type\":\"string\",\"example\":\"User\"},\"site_admin\":{\"type\":\"boolean\"},\"starred_at\":{\"type\":\"string\",\"example\":\"\\\"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\"]}]},\"publisher\":{\"readOnly\":true,\"nullable\":true,\"description\":\"The publisher of the advisory.\",\"allOf\":[{\"title\":\"Simple User\",\"description\":\"A GitHub user.\",\"type\":\"object\",\"properties\":{\"name\":{\"nullable\":true,\"type\":\"string\"},\"email\":{\"nullable\":true,\"type\":\"string\"},\"login\":{\"type\":\"string\",\"example\":\"octocat\"},\"id\":{\"type\":\"integer\",\"example\":1},\"node_id\":{\"type\":\"string\",\"example\":\"MDQ6VXNlcjE=\"},\"avatar_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://github.com/images/error/octocat_happy.gif\"},\"gravatar_id\":{\"type\":\"string\",\"example\":\"41d064eb2195891e12d0413f63227ea7\",\"nullable\":true},\"url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/users/octocat\"},\"html_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://github.com/octocat\"},\"followers_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/users/octocat/followers\"},\"following_url\":{\"type\":\"string\",\"example\":\"https://api.github.com/users/octocat/following{/other_user}\"},\"gists_url\":{\"type\":\"string\",\"example\":\"https://api.github.com/users/octocat/gists{/gist_id}\"},\"starred_url\":{\"type\":\"string\",\"example\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\"},\"subscriptions_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/users/octocat/subscriptions\"},\"organizations_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/users/octocat/orgs\"},\"repos_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/users/octocat/repos\"},\"events_url\":{\"type\":\"string\",\"example\":\"https://api.github.com/users/octocat/events{/privacy}\"},\"received_events_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/users/octocat/received_events\"},\"type\":{\"type\":\"string\",\"example\":\"User\"},\"site_admin\":{\"type\":\"boolean\"},\"starred_at\":{\"type\":\"string\",\"example\":\"\\\"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\"]}]},\"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\",\"format\":\"date-time\",\"description\":\"The date and time of when the advisory was created, in ISO 8601 format.\",\"readOnly\":true,\"nullable\":true},\"updated_at\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"The date and time of when the advisory was last updated, in ISO 8601 format.\",\"readOnly\":true,\"nullable\":true},\"published_at\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"The date and time of when the advisory was published, in ISO 8601 format.\",\"readOnly\":true,\"nullable\":true},\"closed_at\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"The date and time of when the advisory was closed, in ISO 8601 format.\",\"readOnly\":true,\"nullable\":true},\"withdrawn_at\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"The date and time of when the advisory was withdrawn, in ISO 8601 format.\",\"readOnly\":true,\"nullable\":true},\"submission\":{\"type\":\"object\",\"nullable\":true,\"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\",\"nullable\":true,\"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\",\"nullable\":true,\"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\",\"description\":\"The unique package name within its ecosystem.\",\"nullable\":true}},\"required\":[\"ecosystem\",\"name\"]},\"vulnerable_version_range\":{\"type\":\"string\",\"description\":\"The range of the package versions affected by the vulnerability.\",\"nullable\":true},\"patched_versions\":{\"type\":\"string\",\"description\":\"The package version(s) that resolve the vulnerability.\",\"nullable\":true},\"vulnerable_functions\":{\"type\":\"array\",\"description\":\"The functions in the package that are affected.\",\"nullable\":true,\"items\":{\"type\":\"string\"}}},\"required\":[\"package\",\"vulnerable_version_range\",\"patched_versions\",\"vulnerable_functions\"],\"additionalProperties\":false}},\"cvss\":{\"type\":\"object\",\"nullable\":true,\"properties\":{\"vector_string\":{\"type\":\"string\",\"description\":\"The CVSS vector.\",\"nullable\":true},\"score\":{\"type\":\"number\",\"description\":\"The CVSS score.\",\"minimum\":0,\"maximum\":10,\"nullable\":true,\"readOnly\":true}},\"required\":[\"vector_string\",\"score\"]},\"cwes\":{\"type\":\"array\",\"nullable\":true,\"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\",\"description\":\"A list of only the CWE IDs.\",\"nullable\":true,\"items\":{\"type\":\"string\"}},\"credits\":{\"type\":\"array\",\"nullable\":true,\"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\",\"nullable\":true,\"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\":{\"nullable\":true,\"type\":\"string\"},\"email\":{\"nullable\":true,\"type\":\"string\"},\"login\":{\"type\":\"string\",\"example\":\"octocat\"},\"id\":{\"type\":\"integer\",\"example\":1},\"node_id\":{\"type\":\"string\",\"example\":\"MDQ6VXNlcjE=\"},\"avatar_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://github.com/images/error/octocat_happy.gif\"},\"gravatar_id\":{\"type\":\"string\",\"example\":\"41d064eb2195891e12d0413f63227ea7\",\"nullable\":true},\"url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/users/octocat\"},\"html_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://github.com/octocat\"},\"followers_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/users/octocat/followers\"},\"following_url\":{\"type\":\"string\",\"example\":\"https://api.github.com/users/octocat/following{/other_user}\"},\"gists_url\":{\"type\":\"string\",\"example\":\"https://api.github.com/users/octocat/gists{/gist_id}\"},\"starred_url\":{\"type\":\"string\",\"example\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\"},\"subscriptions_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/users/octocat/subscriptions\"},\"organizations_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/users/octocat/orgs\"},\"repos_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/users/octocat/repos\"},\"events_url\":{\"type\":\"string\",\"example\":\"https://api.github.com/users/octocat/events{/privacy}\"},\"received_events_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/users/octocat/received_events\"},\"type\":{\"type\":\"string\",\"example\":\"User\"},\"site_admin\":{\"type\":\"boolean\"},\"starred_at\":{\"type\":\"string\",\"example\":\"\\\"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}}" + "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\",\"description\":\"The Common Vulnerabilities and Exposures (CVE) ID.\",\"nullable\":true},\"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\",\"description\":\"A detailed description of what the advisory entails.\",\"maxLength\":65535,\"nullable\":true},\"severity\":{\"type\":\"string\",\"description\":\"The severity of the advisory.\",\"nullable\":true,\"enum\":[\"critical\",\"high\",\"medium\",\"low\"]},\"author\":{\"readOnly\":true,\"nullable\":true,\"description\":\"The author of the advisory.\",\"allOf\":[{\"title\":\"Simple User\",\"description\":\"A GitHub user.\",\"type\":\"object\",\"properties\":{\"name\":{\"nullable\":true,\"type\":\"string\"},\"email\":{\"nullable\":true,\"type\":\"string\"},\"login\":{\"type\":\"string\",\"example\":\"octocat\"},\"id\":{\"type\":\"integer\",\"example\":1},\"node_id\":{\"type\":\"string\",\"example\":\"MDQ6VXNlcjE=\"},\"avatar_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://github.com/images/error/octocat_happy.gif\"},\"gravatar_id\":{\"type\":\"string\",\"example\":\"41d064eb2195891e12d0413f63227ea7\",\"nullable\":true},\"url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/users/octocat\"},\"html_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://github.com/octocat\"},\"followers_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/users/octocat/followers\"},\"following_url\":{\"type\":\"string\",\"example\":\"https://api.github.com/users/octocat/following{/other_user}\"},\"gists_url\":{\"type\":\"string\",\"example\":\"https://api.github.com/users/octocat/gists{/gist_id}\"},\"starred_url\":{\"type\":\"string\",\"example\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\"},\"subscriptions_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/users/octocat/subscriptions\"},\"organizations_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/users/octocat/orgs\"},\"repos_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/users/octocat/repos\"},\"events_url\":{\"type\":\"string\",\"example\":\"https://api.github.com/users/octocat/events{/privacy}\"},\"received_events_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/users/octocat/received_events\"},\"type\":{\"type\":\"string\",\"example\":\"User\"},\"site_admin\":{\"type\":\"boolean\"},\"starred_at\":{\"type\":\"string\",\"example\":\"\\\"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\"]}]},\"publisher\":{\"readOnly\":true,\"nullable\":true,\"description\":\"The publisher of the advisory.\",\"allOf\":[{\"title\":\"Simple User\",\"description\":\"A GitHub user.\",\"type\":\"object\",\"properties\":{\"name\":{\"nullable\":true,\"type\":\"string\"},\"email\":{\"nullable\":true,\"type\":\"string\"},\"login\":{\"type\":\"string\",\"example\":\"octocat\"},\"id\":{\"type\":\"integer\",\"example\":1},\"node_id\":{\"type\":\"string\",\"example\":\"MDQ6VXNlcjE=\"},\"avatar_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://github.com/images/error/octocat_happy.gif\"},\"gravatar_id\":{\"type\":\"string\",\"example\":\"41d064eb2195891e12d0413f63227ea7\",\"nullable\":true},\"url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/users/octocat\"},\"html_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://github.com/octocat\"},\"followers_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/users/octocat/followers\"},\"following_url\":{\"type\":\"string\",\"example\":\"https://api.github.com/users/octocat/following{/other_user}\"},\"gists_url\":{\"type\":\"string\",\"example\":\"https://api.github.com/users/octocat/gists{/gist_id}\"},\"starred_url\":{\"type\":\"string\",\"example\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\"},\"subscriptions_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/users/octocat/subscriptions\"},\"organizations_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/users/octocat/orgs\"},\"repos_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/users/octocat/repos\"},\"events_url\":{\"type\":\"string\",\"example\":\"https://api.github.com/users/octocat/events{/privacy}\"},\"received_events_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/users/octocat/received_events\"},\"type\":{\"type\":\"string\",\"example\":\"User\"},\"site_admin\":{\"type\":\"boolean\"},\"starred_at\":{\"type\":\"string\",\"example\":\"\\\"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\"]}]},\"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\",\"format\":\"date-time\",\"description\":\"The date and time of when the advisory was created, in ISO 8601 format.\",\"readOnly\":true,\"nullable\":true},\"updated_at\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"The date and time of when the advisory was last updated, in ISO 8601 format.\",\"readOnly\":true,\"nullable\":true},\"published_at\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"The date and time of when the advisory was published, in ISO 8601 format.\",\"readOnly\":true,\"nullable\":true},\"closed_at\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"The date and time of when the advisory was closed, in ISO 8601 format.\",\"readOnly\":true,\"nullable\":true},\"withdrawn_at\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"The date and time of when the advisory was withdrawn, in ISO 8601 format.\",\"readOnly\":true,\"nullable\":true},\"submission\":{\"type\":\"object\",\"nullable\":true,\"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\",\"nullable\":true,\"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\",\"nullable\":true,\"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\",\"description\":\"The unique package name within its ecosystem.\",\"nullable\":true}},\"required\":[\"ecosystem\",\"name\"]},\"vulnerable_version_range\":{\"type\":\"string\",\"description\":\"The range of the package versions affected by the vulnerability.\",\"nullable\":true},\"patched_versions\":{\"type\":\"string\",\"description\":\"The package version(s) that resolve the vulnerability.\",\"nullable\":true},\"vulnerable_functions\":{\"type\":\"array\",\"description\":\"The functions in the package that are affected.\",\"nullable\":true,\"items\":{\"type\":\"string\"}}},\"required\":[\"package\",\"vulnerable_version_range\",\"patched_versions\",\"vulnerable_functions\"],\"additionalProperties\":false}},\"cvss\":{\"type\":\"object\",\"nullable\":true,\"properties\":{\"vector_string\":{\"type\":\"string\",\"description\":\"The CVSS vector.\",\"nullable\":true},\"score\":{\"type\":\"number\",\"description\":\"The CVSS score.\",\"minimum\":0,\"maximum\":10,\"nullable\":true,\"readOnly\":true}},\"required\":[\"vector_string\",\"score\"]},\"cwes\":{\"type\":\"array\",\"nullable\":true,\"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\",\"description\":\"A list of only the CWE IDs.\",\"nullable\":true,\"items\":{\"type\":\"string\"}},\"credits\":{\"type\":\"array\",\"nullable\":true,\"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\",\"nullable\":true,\"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\":{\"nullable\":true,\"type\":\"string\"},\"email\":{\"nullable\":true,\"type\":\"string\"},\"login\":{\"type\":\"string\",\"example\":\"octocat\"},\"id\":{\"type\":\"integer\",\"example\":1},\"node_id\":{\"type\":\"string\",\"example\":\"MDQ6VXNlcjE=\"},\"avatar_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://github.com/images/error/octocat_happy.gif\"},\"gravatar_id\":{\"type\":\"string\",\"example\":\"41d064eb2195891e12d0413f63227ea7\",\"nullable\":true},\"url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/users/octocat\"},\"html_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://github.com/octocat\"},\"followers_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/users/octocat/followers\"},\"following_url\":{\"type\":\"string\",\"example\":\"https://api.github.com/users/octocat/following{/other_user}\"},\"gists_url\":{\"type\":\"string\",\"example\":\"https://api.github.com/users/octocat/gists{/gist_id}\"},\"starred_url\":{\"type\":\"string\",\"example\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\"},\"subscriptions_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/users/octocat/subscriptions\"},\"organizations_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/users/octocat/orgs\"},\"repos_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/users/octocat/repos\"},\"events_url\":{\"type\":\"string\",\"example\":\"https://api.github.com/users/octocat/events{/privacy}\"},\"received_events_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/users/octocat/received_events\"},\"type\":{\"type\":\"string\",\"example\":\"User\"},\"site_admin\":{\"type\":\"boolean\"},\"starred_at\":{\"type\":\"string\",\"example\":\"\\\"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}" }, { - "code": 400, + "code": 403, "schema": "{\"title\":\"Basic Error\",\"description\":\"Basic Error\",\"type\":\"object\",\"properties\":{\"message\":{\"type\":\"string\"},\"documentation_url\":{\"type\":\"string\"},\"url\":{\"type\":\"string\"},\"status\":{\"type\":\"string\"}}}" } ],