Security Configuration feature options for code scanning
", + "childParamsGroups": [ + { + "type": "boolean or null", + "name": "allow_advanced", + "description": "Whether to allow repos which use advanced setup
" + } + ] + }, { "type": "string", "name": "code_scanning_default_setup", @@ -171719,7 +171741,16 @@ "object", "null" ], - "description": "Feature options for code scanning" + "description": "Feature options for code scanning", + "properties": { + "allow_advanced": { + "type": [ + "boolean", + "null" + ], + "description": "Whether to allow repos which use advanced setup" + } + } }, "code_scanning_default_setup": { "type": "string", @@ -171983,6 +172014,9 @@ "runner_type": "not_set", "runner_label": null }, + "code_scanning_options": { + "allow_advanced": false + }, "secret_scanning": "enabled", "secret_scanning_push_protection": "enabled", "secret_scanning_delegated_bypass": "enabled", @@ -172025,6 +172059,9 @@ "runner_type": "not_set", "runner_label": null }, + "code_scanning_options": { + "allow_advanced": false + }, "secret_scanning": "enabled", "secret_scanning_push_protection": "enabled", "secret_scanning_delegated_bypass": "disabled", @@ -172138,7 +172175,16 @@ "object", "null" ], - "description": "Feature options for code scanning" + "description": "Feature options for code scanning", + "properties": { + "allow_advanced": { + "type": [ + "boolean", + "null" + ], + "description": "Whether to allow repos which use advanced setup" + } + } }, "code_scanning_default_setup": { "type": "string", @@ -172497,7 +172543,16 @@ "object", "null" ], - "description": "Feature options for code scanning" + "description": "Feature options for code scanning", + "properties": { + "allow_advanced": { + "type": [ + "boolean", + "null" + ], + "description": "Whether to allow repos which use advanced setup" + } + } }, "code_scanning_default_setup": { "type": "string", @@ -173110,7 +173165,16 @@ "object", "null" ], - "description": "Feature options for code scanning" + "description": "Feature options for code scanning", + "properties": { + "allow_advanced": { + "type": [ + "boolean", + "null" + ], + "description": "Whether to allow repos which use advanced setup" + } + } }, "code_scanning_default_setup": { "type": "string", @@ -173574,6 +173638,9 @@ "runner_type": "not_set", "runner_label": null }, + "code_scanning_options": { + "allow_advanced": false + }, "code_scanning_delegated_alert_dismissal": "disabled", "secret_scanning": "enabled", "secret_scanning_push_protection": "disabled", @@ -173690,7 +173757,16 @@ "object", "null" ], - "description": "Feature options for code scanning" + "description": "Feature options for code scanning", + "properties": { + "allow_advanced": { + "type": [ + "boolean", + "null" + ], + "description": "Whether to allow repos which use advanced setup" + } + } }, "code_scanning_default_setup": { "type": "string", @@ -174889,7 +174965,16 @@ "object", "null" ], - "description": "Feature options for code scanning" + "description": "Feature options for code scanning", + "properties": { + "allow_advanced": { + "type": [ + "boolean", + "null" + ], + "description": "Whether to allow repos which use advanced setup" + } + } }, "code_scanning_default_setup": { "type": "string", @@ -175209,6 +175294,19 @@ ], "default": "disabled" }, + { + "type": "object or null", + "name": "code_scanning_options", + "in": "body", + "description": "Security Configuration feature options for code scanning
", + "childParamsGroups": [ + { + "type": "boolean or null", + "name": "allow_advanced", + "description": "Whether to allow repos which use advanced setup
" + } + ] + }, { "type": "string", "name": "code_scanning_default_setup", @@ -175456,6 +175554,9 @@ "runner_type": "not_set", "runner_label": null }, + "code_scanning_options": { + "allow_advanced": false + }, "code_scanning_delegated_alert_dismissal": "disabled", "secret_scanning": "enabled", "secret_scanning_push_protection": "disabled", @@ -175557,7 +175658,16 @@ "object", "null" ], - "description": "Feature options for code scanning" + "description": "Feature options for code scanning", + "properties": { + "allow_advanced": { + "type": [ + "boolean", + "null" + ], + "description": "Whether to allow repos which use advanced setup" + } + } }, "code_scanning_default_setup": { "type": "string", @@ -175813,6 +175923,9 @@ "runner_type": "not_set", "runner_label": null }, + "code_scanning_options": { + "allow_advanced": false + }, "secret_scanning": "enabled", "secret_scanning_push_protection": "enabled", "secret_scanning_delegated_bypass": "enabled", @@ -175855,6 +175968,9 @@ "runner_type": "not_set", "runner_label": null }, + "code_scanning_options": { + "allow_advanced": false + }, "secret_scanning": "enabled", "secret_scanning_push_protection": "enabled", "secret_scanning_delegated_bypass": "disabled", @@ -175968,7 +176084,16 @@ "object", "null" ], - "description": "Feature options for code scanning" + "description": "Feature options for code scanning", + "properties": { + "allow_advanced": { + "type": [ + "boolean", + "null" + ], + "description": "Whether to allow repos which use advanced setup" + } + } }, "code_scanning_default_setup": { "type": "string", @@ -176330,6 +176455,9 @@ "runner_type": "not_set", "runner_label": null }, + "code_scanning_options": { + "allow_advanced": false + }, "code_scanning_delegated_alert_dismissal": "disabled", "secret_scanning": "enabled", "secret_scanning_push_protection": "disabled", @@ -176431,7 +176559,16 @@ "object", "null" ], - "description": "Feature options for code scanning" + "description": "Feature options for code scanning", + "properties": { + "allow_advanced": { + "type": [ + "boolean", + "null" + ], + "description": "Whether to allow repos which use advanced setup" + } + } }, "code_scanning_default_setup": { "type": "string", @@ -176991,6 +177128,9 @@ "runner_type": "not_set", "runner_label": null }, + "code_scanning_options": { + "allow_advanced": false + }, "code_scanning_delegated_alert_dismissal": "disabled", "secret_scanning": "disabled", "secret_scanning_push_protection": "disabled", @@ -177092,7 +177232,16 @@ "object", "null" ], - "description": "Feature options for code scanning" + "description": "Feature options for code scanning", + "properties": { + "allow_advanced": { + "type": [ + "boolean", + "null" + ], + "description": "Whether to allow repos which use advanced setup" + } + } }, "code_scanning_default_setup": { "type": "string", @@ -177557,6 +177706,9 @@ "runner_type": "not_set", "runner_label": null }, + "code_scanning_options": { + "allow_advanced": false + }, "code_scanning_delegated_alert_dismissal": "disabled", "secret_scanning": "enabled", "secret_scanning_push_protection": "disabled", @@ -177673,7 +177825,16 @@ "object", "null" ], - "description": "Feature options for code scanning" + "description": "Feature options for code scanning", + "properties": { + "allow_advanced": { + "type": [ + "boolean", + "null" + ], + "description": "Whether to allow repos which use advanced setup" + } + } }, "code_scanning_default_setup": { "type": "string", @@ -178825,7 +178986,16 @@ "object", "null" ], - "description": "Feature options for code scanning" + "description": "Feature options for code scanning", + "properties": { + "allow_advanced": { + "type": [ + "boolean", + "null" + ], + "description": "Whether to allow repos which use advanced setup" + } + } }, "code_scanning_default_setup": { "type": "string", @@ -348873,7 +349043,7 @@ } ], "previews": [], - "descriptionHTML": "You can use the REST API to list the sub-issues on an issue.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.You can use the REST API to list the sub-issues on an issue.
\nThis endpoint supports the following custom media types. For more information, see Media types.
\napplication/vnd.github.raw+json: Returns the raw Markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the Markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's Markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.Merges must be performed via a merge queue.
", - "isRequired": [ - "type" - ], - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "merge_queue" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "check_response_timeout_minutes", - "description": "Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed
", - "isRequired": true - }, - { - "type": "string", - "name": "grouping_strategy", - "description": "When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge.
", - "isRequired": true, - "enum": [ - "ALLGREEN", - "HEADGREEN" - ] - }, - { - "type": "integer", - "name": "max_entries_to_build", - "description": "Limit the number of queued pull requests requesting checks and workflow runs at the same time.
", - "isRequired": true - }, - { - "type": "integer", - "name": "max_entries_to_merge", - "description": "The maximum number of PRs that will be merged together in a group.
", - "isRequired": true - }, - { - "type": "string", - "name": "merge_method", - "description": "Method to use when merging changes from queued pull requests.
", - "isRequired": true, - "enum": [ - "MERGE", - "SQUASH", - "REBASE" - ] - }, - { - "type": "integer", - "name": "min_entries_to_merge", - "description": "The minimum number of PRs that will be merged together in a group.
", - "isRequired": true - }, - { - "type": "integer", - "name": "min_entries_to_merge_wait_minutes", - "description": "The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.
", - "isRequired": true - } - ] - } - ] - }, { "type": "object", "name": "required_deployments", @@ -415858,83 +415951,6 @@ } ] }, - { - "type": "object", - "name": "merge_queue", - "description": "Merges must be performed via a merge queue.
", - "isRequired": [ - "type" - ], - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "merge_queue" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "check_response_timeout_minutes", - "description": "Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed
", - "isRequired": true - }, - { - "type": "string", - "name": "grouping_strategy", - "description": "When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge.
", - "isRequired": true, - "enum": [ - "ALLGREEN", - "HEADGREEN" - ] - }, - { - "type": "integer", - "name": "max_entries_to_build", - "description": "Limit the number of queued pull requests requesting checks and workflow runs at the same time.
", - "isRequired": true - }, - { - "type": "integer", - "name": "max_entries_to_merge", - "description": "The maximum number of PRs that will be merged together in a group.
", - "isRequired": true - }, - { - "type": "string", - "name": "merge_method", - "description": "Method to use when merging changes from queued pull requests.
", - "isRequired": true, - "enum": [ - "MERGE", - "SQUASH", - "REBASE" - ] - }, - { - "type": "integer", - "name": "min_entries_to_merge", - "description": "The minimum number of PRs that will be merged together in a group.
", - "isRequired": true - }, - { - "type": "integer", - "name": "min_entries_to_merge_wait_minutes", - "description": "The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.
", - "isRequired": true - } - ] - } - ] - }, { "type": "object", "name": "required_deployments", @@ -437678,7 +437694,12 @@ "composer_repository", "docker_registry", "git_source", - "helm_registry" + "helm_registry", + "hex_organization", + "hex_repository", + "pub_repository", + "python_index", + "terraform_registry" ], "type": "string" }, @@ -437776,7 +437797,12 @@ "composer_repository", "docker_registry", "git_source", - "helm_registry" + "helm_registry", + "hex_organization", + "hex_repository", + "pub_repository", + "python_index", + "terraform_registry" ] }, { @@ -437894,7 +437920,12 @@ "composer_repository", "docker_registry", "git_source", - "helm_registry" + "helm_registry", + "hex_organization", + "hex_repository", + "pub_repository", + "python_index", + "terraform_registry" ], "type": "string" }, @@ -437998,7 +438029,12 @@ "composer_repository", "docker_registry", "git_source", - "helm_registry" + "helm_registry", + "hex_organization", + "hex_repository", + "pub_repository", + "python_index", + "terraform_registry" ], "type": "string" }, @@ -438233,7 +438269,12 @@ "composer_repository", "docker_registry", "git_source", - "helm_registry" + "helm_registry", + "hex_organization", + "hex_repository", + "pub_repository", + "python_index", + "terraform_registry" ], "type": "string" }, @@ -438332,7 +438373,12 @@ "composer_repository", "docker_registry", "git_source", - "helm_registry" + "helm_registry", + "hex_organization", + "hex_repository", + "pub_repository", + "python_index", + "terraform_registry" ] }, { diff --git a/src/rest/data/ghec-2022-11-28/schema.json b/src/rest/data/ghec-2022-11-28/schema.json index c436d482340c..ff70116e54e4 100644 --- a/src/rest/data/ghec-2022-11-28/schema.json +++ b/src/rest/data/ghec-2022-11-28/schema.json @@ -183522,7 +183522,16 @@ "object", "null" ], - "description": "Feature options for code scanning" + "description": "Feature options for code scanning", + "properties": { + "allow_advanced": { + "type": [ + "boolean", + "null" + ], + "description": "Whether to allow repos which use advanced setup" + } + } }, "code_scanning_default_setup": { "type": "string", @@ -183842,6 +183851,19 @@ ], "default": "disabled" }, + { + "type": "object or null", + "name": "code_scanning_options", + "in": "body", + "description": "Security Configuration feature options for code scanning
", + "childParamsGroups": [ + { + "type": "boolean or null", + "name": "allow_advanced", + "description": "Whether to allow repos which use advanced setup
" + } + ] + }, { "type": "string", "name": "code_scanning_default_setup", @@ -184140,7 +184162,16 @@ "object", "null" ], - "description": "Feature options for code scanning" + "description": "Feature options for code scanning", + "properties": { + "allow_advanced": { + "type": [ + "boolean", + "null" + ], + "description": "Whether to allow repos which use advanced setup" + } + } }, "code_scanning_default_setup": { "type": "string", @@ -184404,6 +184435,9 @@ "runner_type": "not_set", "runner_label": null }, + "code_scanning_options": { + "allow_advanced": false + }, "secret_scanning": "enabled", "secret_scanning_push_protection": "enabled", "secret_scanning_delegated_bypass": "enabled", @@ -184446,6 +184480,9 @@ "runner_type": "not_set", "runner_label": null }, + "code_scanning_options": { + "allow_advanced": false + }, "secret_scanning": "enabled", "secret_scanning_push_protection": "enabled", "secret_scanning_delegated_bypass": "disabled", @@ -184559,7 +184596,16 @@ "object", "null" ], - "description": "Feature options for code scanning" + "description": "Feature options for code scanning", + "properties": { + "allow_advanced": { + "type": [ + "boolean", + "null" + ], + "description": "Whether to allow repos which use advanced setup" + } + } }, "code_scanning_default_setup": { "type": "string", @@ -184918,7 +184964,16 @@ "object", "null" ], - "description": "Feature options for code scanning" + "description": "Feature options for code scanning", + "properties": { + "allow_advanced": { + "type": [ + "boolean", + "null" + ], + "description": "Whether to allow repos which use advanced setup" + } + } }, "code_scanning_default_setup": { "type": "string", @@ -185531,7 +185586,16 @@ "object", "null" ], - "description": "Feature options for code scanning" + "description": "Feature options for code scanning", + "properties": { + "allow_advanced": { + "type": [ + "boolean", + "null" + ], + "description": "Whether to allow repos which use advanced setup" + } + } }, "code_scanning_default_setup": { "type": "string", @@ -185995,6 +186059,9 @@ "runner_type": "not_set", "runner_label": null }, + "code_scanning_options": { + "allow_advanced": false + }, "code_scanning_delegated_alert_dismissal": "disabled", "secret_scanning": "enabled", "secret_scanning_push_protection": "disabled", @@ -186111,7 +186178,16 @@ "object", "null" ], - "description": "Feature options for code scanning" + "description": "Feature options for code scanning", + "properties": { + "allow_advanced": { + "type": [ + "boolean", + "null" + ], + "description": "Whether to allow repos which use advanced setup" + } + } }, "code_scanning_default_setup": { "type": "string", @@ -187310,7 +187386,16 @@ "object", "null" ], - "description": "Feature options for code scanning" + "description": "Feature options for code scanning", + "properties": { + "allow_advanced": { + "type": [ + "boolean", + "null" + ], + "description": "Whether to allow repos which use advanced setup" + } + } }, "code_scanning_default_setup": { "type": "string", @@ -187630,6 +187715,19 @@ ], "default": "disabled" }, + { + "type": "object or null", + "name": "code_scanning_options", + "in": "body", + "description": "Security Configuration feature options for code scanning
", + "childParamsGroups": [ + { + "type": "boolean or null", + "name": "allow_advanced", + "description": "Whether to allow repos which use advanced setup
" + } + ] + }, { "type": "string", "name": "code_scanning_default_setup", @@ -187877,6 +187975,9 @@ "runner_type": "not_set", "runner_label": null }, + "code_scanning_options": { + "allow_advanced": false + }, "code_scanning_delegated_alert_dismissal": "disabled", "secret_scanning": "enabled", "secret_scanning_push_protection": "disabled", @@ -187978,7 +188079,16 @@ "object", "null" ], - "description": "Feature options for code scanning" + "description": "Feature options for code scanning", + "properties": { + "allow_advanced": { + "type": [ + "boolean", + "null" + ], + "description": "Whether to allow repos which use advanced setup" + } + } }, "code_scanning_default_setup": { "type": "string", @@ -188234,6 +188344,9 @@ "runner_type": "not_set", "runner_label": null }, + "code_scanning_options": { + "allow_advanced": false + }, "secret_scanning": "enabled", "secret_scanning_push_protection": "enabled", "secret_scanning_delegated_bypass": "enabled", @@ -188276,6 +188389,9 @@ "runner_type": "not_set", "runner_label": null }, + "code_scanning_options": { + "allow_advanced": false + }, "secret_scanning": "enabled", "secret_scanning_push_protection": "enabled", "secret_scanning_delegated_bypass": "disabled", @@ -188389,7 +188505,16 @@ "object", "null" ], - "description": "Feature options for code scanning" + "description": "Feature options for code scanning", + "properties": { + "allow_advanced": { + "type": [ + "boolean", + "null" + ], + "description": "Whether to allow repos which use advanced setup" + } + } }, "code_scanning_default_setup": { "type": "string", @@ -188751,6 +188876,9 @@ "runner_type": "not_set", "runner_label": null }, + "code_scanning_options": { + "allow_advanced": false + }, "code_scanning_delegated_alert_dismissal": "disabled", "secret_scanning": "enabled", "secret_scanning_push_protection": "disabled", @@ -188852,7 +188980,16 @@ "object", "null" ], - "description": "Feature options for code scanning" + "description": "Feature options for code scanning", + "properties": { + "allow_advanced": { + "type": [ + "boolean", + "null" + ], + "description": "Whether to allow repos which use advanced setup" + } + } }, "code_scanning_default_setup": { "type": "string", @@ -189412,6 +189549,9 @@ "runner_type": "not_set", "runner_label": null }, + "code_scanning_options": { + "allow_advanced": false + }, "code_scanning_delegated_alert_dismissal": "disabled", "secret_scanning": "disabled", "secret_scanning_push_protection": "disabled", @@ -189513,7 +189653,16 @@ "object", "null" ], - "description": "Feature options for code scanning" + "description": "Feature options for code scanning", + "properties": { + "allow_advanced": { + "type": [ + "boolean", + "null" + ], + "description": "Whether to allow repos which use advanced setup" + } + } }, "code_scanning_default_setup": { "type": "string", @@ -189978,6 +190127,9 @@ "runner_type": "not_set", "runner_label": null }, + "code_scanning_options": { + "allow_advanced": false + }, "code_scanning_delegated_alert_dismissal": "disabled", "secret_scanning": "enabled", "secret_scanning_push_protection": "disabled", @@ -190094,7 +190246,16 @@ "object", "null" ], - "description": "Feature options for code scanning" + "description": "Feature options for code scanning", + "properties": { + "allow_advanced": { + "type": [ + "boolean", + "null" + ], + "description": "Whether to allow repos which use advanced setup" + } + } }, "code_scanning_default_setup": { "type": "string", @@ -191246,7 +191407,16 @@ "object", "null" ], - "description": "Feature options for code scanning" + "description": "Feature options for code scanning", + "properties": { + "allow_advanced": { + "type": [ + "boolean", + "null" + ], + "description": "Whether to allow repos which use advanced setup" + } + } }, "code_scanning_default_setup": { "type": "string", @@ -292944,83 +293114,6 @@ } ] }, - { - "type": "object", - "name": "merge_queue", - "description": "Merges must be performed via a merge queue.
", - "isRequired": [ - "type" - ], - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "merge_queue" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "check_response_timeout_minutes", - "description": "Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed
", - "isRequired": true - }, - { - "type": "string", - "name": "grouping_strategy", - "description": "When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge.
", - "isRequired": true, - "enum": [ - "ALLGREEN", - "HEADGREEN" - ] - }, - { - "type": "integer", - "name": "max_entries_to_build", - "description": "Limit the number of queued pull requests requesting checks and workflow runs at the same time.
", - "isRequired": true - }, - { - "type": "integer", - "name": "max_entries_to_merge", - "description": "The maximum number of PRs that will be merged together in a group.
", - "isRequired": true - }, - { - "type": "string", - "name": "merge_method", - "description": "Method to use when merging changes from queued pull requests.
", - "isRequired": true, - "enum": [ - "MERGE", - "SQUASH", - "REBASE" - ] - }, - { - "type": "integer", - "name": "min_entries_to_merge", - "description": "The minimum number of PRs that will be merged together in a group.
", - "isRequired": true - }, - { - "type": "integer", - "name": "min_entries_to_merge_wait_minutes", - "description": "The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.
", - "isRequired": true - } - ] - } - ] - }, { "type": "object", "name": "required_deployments", @@ -296998,83 +297091,6 @@ } ] }, - { - "type": "object", - "name": "merge_queue", - "description": "Merges must be performed via a merge queue.
", - "isRequired": [ - "type" - ], - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "merge_queue" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "check_response_timeout_minutes", - "description": "Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed
", - "isRequired": true - }, - { - "type": "string", - "name": "grouping_strategy", - "description": "When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge.
", - "isRequired": true, - "enum": [ - "ALLGREEN", - "HEADGREEN" - ] - }, - { - "type": "integer", - "name": "max_entries_to_build", - "description": "Limit the number of queued pull requests requesting checks and workflow runs at the same time.
", - "isRequired": true - }, - { - "type": "integer", - "name": "max_entries_to_merge", - "description": "The maximum number of PRs that will be merged together in a group.
", - "isRequired": true - }, - { - "type": "string", - "name": "merge_method", - "description": "Method to use when merging changes from queued pull requests.
", - "isRequired": true, - "enum": [ - "MERGE", - "SQUASH", - "REBASE" - ] - }, - { - "type": "integer", - "name": "min_entries_to_merge", - "description": "The minimum number of PRs that will be merged together in a group.
", - "isRequired": true - }, - { - "type": "integer", - "name": "min_entries_to_merge_wait_minutes", - "description": "The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.
", - "isRequired": true - } - ] - } - ] - }, { "type": "object", "name": "required_deployments", @@ -387403,7 +387419,7 @@ } ], "previews": [], - "descriptionHTML": "You can use the REST API to list the sub-issues on an issue.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.You can use the REST API to list the sub-issues on an issue.
\nThis endpoint supports the following custom media types. For more information, see Media types.
\napplication/vnd.github.raw+json: Returns the raw Markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the Markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's Markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.Merges must be performed via a merge queue.
", - "isRequired": [ - "type" - ], - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "merge_queue" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "check_response_timeout_minutes", - "description": "Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed
", - "isRequired": true - }, - { - "type": "string", - "name": "grouping_strategy", - "description": "When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge.
", - "isRequired": true, - "enum": [ - "ALLGREEN", - "HEADGREEN" - ] - }, - { - "type": "integer", - "name": "max_entries_to_build", - "description": "Limit the number of queued pull requests requesting checks and workflow runs at the same time.
", - "isRequired": true - }, - { - "type": "integer", - "name": "max_entries_to_merge", - "description": "The maximum number of PRs that will be merged together in a group.
", - "isRequired": true - }, - { - "type": "string", - "name": "merge_method", - "description": "Method to use when merging changes from queued pull requests.
", - "isRequired": true, - "enum": [ - "MERGE", - "SQUASH", - "REBASE" - ] - }, - { - "type": "integer", - "name": "min_entries_to_merge", - "description": "The minimum number of PRs that will be merged together in a group.
", - "isRequired": true - }, - { - "type": "integer", - "name": "min_entries_to_merge_wait_minutes", - "description": "The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.
", - "isRequired": true - } - ] - } - ] - }, { "type": "object", "name": "required_deployments", @@ -458377,83 +458316,6 @@ } ] }, - { - "type": "object", - "name": "merge_queue", - "description": "Merges must be performed via a merge queue.
", - "isRequired": [ - "type" - ], - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "merge_queue" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "check_response_timeout_minutes", - "description": "Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed
", - "isRequired": true - }, - { - "type": "string", - "name": "grouping_strategy", - "description": "When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge.
", - "isRequired": true, - "enum": [ - "ALLGREEN", - "HEADGREEN" - ] - }, - { - "type": "integer", - "name": "max_entries_to_build", - "description": "Limit the number of queued pull requests requesting checks and workflow runs at the same time.
", - "isRequired": true - }, - { - "type": "integer", - "name": "max_entries_to_merge", - "description": "The maximum number of PRs that will be merged together in a group.
", - "isRequired": true - }, - { - "type": "string", - "name": "merge_method", - "description": "Method to use when merging changes from queued pull requests.
", - "isRequired": true, - "enum": [ - "MERGE", - "SQUASH", - "REBASE" - ] - }, - { - "type": "integer", - "name": "min_entries_to_merge", - "description": "The minimum number of PRs that will be merged together in a group.
", - "isRequired": true - }, - { - "type": "integer", - "name": "min_entries_to_merge_wait_minutes", - "description": "The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.
", - "isRequired": true - } - ] - } - ] - }, { "type": "object", "name": "required_deployments", @@ -480312,7 +480174,12 @@ "composer_repository", "docker_registry", "git_source", - "helm_registry" + "helm_registry", + "hex_organization", + "hex_repository", + "pub_repository", + "python_index", + "terraform_registry" ], "type": "string" }, @@ -480410,7 +480277,12 @@ "composer_repository", "docker_registry", "git_source", - "helm_registry" + "helm_registry", + "hex_organization", + "hex_repository", + "pub_repository", + "python_index", + "terraform_registry" ] }, { @@ -480528,7 +480400,12 @@ "composer_repository", "docker_registry", "git_source", - "helm_registry" + "helm_registry", + "hex_organization", + "hex_repository", + "pub_repository", + "python_index", + "terraform_registry" ], "type": "string" }, @@ -480632,7 +480509,12 @@ "composer_repository", "docker_registry", "git_source", - "helm_registry" + "helm_registry", + "hex_organization", + "hex_repository", + "pub_repository", + "python_index", + "terraform_registry" ], "type": "string" }, @@ -480867,7 +480749,12 @@ "composer_repository", "docker_registry", "git_source", - "helm_registry" + "helm_registry", + "hex_organization", + "hex_repository", + "pub_repository", + "python_index", + "terraform_registry" ], "type": "string" }, @@ -480966,7 +480853,12 @@ "composer_repository", "docker_registry", "git_source", - "helm_registry" + "helm_registry", + "hex_organization", + "hex_repository", + "pub_repository", + "python_index", + "terraform_registry" ] }, { @@ -620455,6 +620347,10 @@ { "\"Secret scanning alerts\" repository permissions": "read", "\"Organization bypass requests for secret scanning\" organization permissions": "read" + }, + { + "\"Secret scanning alerts\" repository permissions": "read", + "\"Secret scanning push protection bypass requests\" repository permissions": "read" } ] }, @@ -621178,6 +621074,10 @@ { "\"Secret scanning alerts\" repository permissions": "read", "\"Organization bypass requests for secret scanning\" organization permissions": "write" + }, + { + "\"Secret scanning alerts\" repository permissions": "read", + "\"Secret scanning push protection bypass requests\" repository permissions": "write" } ] }, diff --git a/src/rest/data/ghes-3.15-2022-11-28/schema.json b/src/rest/data/ghes-3.15-2022-11-28/schema.json index 4f50fb93bf8f..e464c049c45f 100644 --- a/src/rest/data/ghes-3.15-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.15-2022-11-28/schema.json @@ -479,13 +479,13 @@ } ], "previews": [], - "descriptionHTML": "Gets a specific artifact for a workflow run.
\nAnyone with read access to the repository can use this endpoint.
\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Gets a specific artifact for a workflow run.
\nAnyone with read access to the repository can use this endpoint.
\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Gets the total GitHub Actions cache usage for an enterprise.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.
\nOAuth tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Gets the total GitHub Actions cache usage for an enterprise.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.
\nOAuth tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
Lists the organizations that are selected to have GitHub Actions enabled in an enterprise. To use this endpoint, the enterprise permission policy for enabled_organizations must be configured to selected. For more information, see \"Set GitHub Actions permissions for an enterprise.\"
OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Lists the organizations that are selected to have GitHub Actions enabled in an enterprise. To use this endpoint, the enterprise permission policy for enabled_organizations must be configured to selected. For more information, see \"Set GitHub Actions permissions for an enterprise.\"
OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
Adds an organization to the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for enabled_organizations must be configured to selected. For more information, see \"Set GitHub Actions permissions for an enterprise.\"
OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
No Content
" } - ] + ], + "descriptionHTML": "Adds an organization to the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for enabled_organizations must be configured to selected. For more information, see \"Set GitHub Actions permissions for an enterprise.\"
OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
Gets the selected actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for an enterprise.\"
OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Gets the selected actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for an enterprise.\"
OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories must be must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"
OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
No Content
" } - ] + ], + "descriptionHTML": "Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories must be must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"
OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Creates a new self-hosted runner group for an enterprise.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
Created
" } - ] + ], + "descriptionHTML": "Creates a new self-hosted runner group for an enterprise.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
Gets a specific self-hosted runner group for an enterprise.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Gets a specific self-hosted runner group for an enterprise.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
Deletes a self-hosted runner group for an enterprise.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
No Content
" } - ] + ], + "descriptionHTML": "Deletes a self-hosted runner group for an enterprise.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
Lists the self-hosted runners that are in a specific enterprise group.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Lists the self-hosted runners that are in a specific enterprise group.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
No Content
" } - ] + ], + "descriptionHTML": "Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
Adds a repository to the list of repositories that can access a self-hosted runner group. The runner group must have visibility set to selected. For more information, see \"Create a self-hosted runner group for an organization.\"
OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
No Content
" } - ] + ], + "descriptionHTML": "Adds a repository to the list of repositories that can access a self-hosted runner group. The runner group must have visibility set to selected. For more information, see \"Create a self-hosted runner group for an organization.\"
OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Removes a self-hosted runner from a group configured in an organization. The runner is then returned to the default group.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
No Content
" } - ] + ], + "descriptionHTML": "Removes a self-hosted runner from a group configured in an organization. The runner is then returned to the default group.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Returns a token that you can pass to the config script to remove a self-hosted runner from an enterprise. The token expires after one hour.
Example using remove token:
\nTo remove your self-hosted runner from an enterprise, replace TOKEN with the remove token provided by this\nendpoint.
./config.sh remove --token TOKEN\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
Created
" } - ] + ], + "descriptionHTML": "Returns a token that you can pass to the config script to remove a self-hosted runner from an enterprise. The token expires after one hour.
Example using remove token:
\nTo remove your self-hosted runner from an enterprise, replace TOKEN with the remove token provided by this\nendpoint.
./config.sh remove --token TOKEN\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
Lists all labels for a self-hosted runner configured in an organization.
\nAuthenticated users must have admin access to the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.
Resource not found
" } - ] + ], + "descriptionHTML": "Lists all labels for a self-hosted runner configured in an organization.
\nAuthenticated users must have admin access to the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.
Creates an organization variable that you can reference in a GitHub Actions workflow.
\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
\nOAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Response when creating a variable
" } - ] + ], + "descriptionHTML": "Creates an organization variable that you can reference in a GitHub Actions workflow.
\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
\nOAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Updates an organization variable that you can reference in a GitHub Actions workflow.
\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.
No Content
" } - ] + ], + "descriptionHTML": "Updates an organization variable that you can reference in a GitHub Actions workflow.
\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.
Note
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nOK
" } - ] + ], + "descriptionHTML": "Note
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nGets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Lists all repositories that have been selected when the visibility\nfor repository access to a secret is set to selected.
OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Lists all repositories that have been selected when the visibility\nfor repository access to a secret is set to selected.
OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Removes a repository from an organization secret when the visibility\nfor repository access is set to selected. The visibility is set when you Create\nor update an organization secret.
OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Conflict when visibility type not set to selected
" } - ] + ], + "descriptionHTML": "Removes a repository from an organization secret when the visibility\nfor repository access is set to selected. The visibility is set when you Create\nor update an organization secret.
OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -205335,13 +205335,13 @@ } ], "previews": [], - "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ] + ], + "descriptionHTML": "" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -205938,13 +205938,13 @@ } ], "previews": [], - "descriptionHTML": "Removes the global announcement banner in your enterprise.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } - ] + ], + "descriptionHTML": "Removes the global announcement banner in your enterprise.
" } ], "audit-log": [ @@ -211419,13 +211419,13 @@ } ], "previews": [], - "descriptionHTML": "Removes any overrides for this hook at the org level for this org.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ] + ], + "descriptionHTML": "Removes any overrides for this hook at the org level for this org.
" } ], "orgs": [ @@ -213462,13 +213462,13 @@ } ], "previews": [], - "descriptionHTML": "List all pre-receive hooks that are enabled or testing for this repository as well as any disabled hooks that are allowed to be enabled at the repository level. Pre-receive hooks that are disabled at a higher level and are not configurable will not be listed.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ] + ], + "descriptionHTML": "List all pre-receive hooks that are enabled or testing for this repository as well as any disabled hooks that are allowed to be enabled at the repository level. Pre-receive hooks that are disabled at a higher level and are not configurable will not be listed.
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -296571,13 +296571,13 @@ } ], "previews": [], - "descriptionHTML": "Lists labels for issues in a milestone.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ] + ], + "descriptionHTML": "Lists labels for issues in a milestone.
" } ], "milestones": [ @@ -338646,13 +338646,13 @@ } ], "previews": [], - "descriptionHTML": "Gets the audit log for an organization. For more information, see \"Reviewing the audit log for your organization.\"
\nBy default, the response includes up to 30 events from the past three months. Use the phrase parameter to filter results and retrieve older events. For example, use the phrase parameter with the created qualifier to filter events based on when the events occurred. For more information, see \"Reviewing the audit log for your organization.\"
Use pagination to retrieve fewer or more than 30 events. For more information, see \"Using pagination in the REST API.\"
\nThe authenticated user must be an organization owner to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the read:audit_log scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Gets the audit log for an organization. For more information, see \"Reviewing the audit log for your organization.\"
\nBy default, the response includes up to 30 events from the past three months. Use the phrase parameter to filter results and retrieve older events. For example, use the phrase parameter with the created qualifier to filter events based on when the events occurred. For more information, see \"Reviewing the audit log for your organization.\"
Use pagination to retrieve fewer or more than 30 events. For more information, see \"Using pagination in the REST API.\"
\nThe authenticated user must be an organization owner to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the read:audit_log scope to use this endpoint.
Warning
\n\nClosing down notice: This operation is closing down and will be removed in the future. Use the \"List custom repository roles\" endpoint instead.
\nList the custom repository roles available in this organization. For more information on custom repository roles, see \"About custom repository roles.\"
\nThe authenticated user must be administrator of the organization or of a repository of the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org or repo scope to use this endpoint.
Response - list of custom role names
" } - ] + ], + "descriptionHTML": "Warning
\n\nClosing down notice: This operation is closing down and will be removed in the future. Use the \"List custom repository roles\" endpoint instead.
\nList the custom repository roles available in this organization. For more information on custom repository roles, see \"About custom repository roles.\"
\nThe authenticated user must be administrator of the organization or of a repository of the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org or repo scope to use this endpoint.
Updates a custom repository role that can be used by all repositories owned by the organization. For more information about custom repository roles, see \"About custom repository roles.\"
\nThe authenticated user must be an administrator for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Validation failed, or the endpoint has been spammed.
" } - ] + ], + "descriptionHTML": "Updates a custom repository role that can be used by all repositories owned by the organization. For more information about custom repository roles, see \"About custom repository roles.\"
\nThe authenticated user must be an administrator for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Lists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see \"About custom repository roles.\"
\nThe authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org or repo scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Lists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see \"About custom repository roles.\"
\nThe authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org or repo scope to use this endpoint.
Removes an organization role from a team. For more information on organization roles, see \"Using organization roles.\"
\nThe authenticated user must be an administrator for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
No Content
" } - ] + ], + "descriptionHTML": "Removes an organization role from a team. For more information on organization roles, see \"Using organization roles.\"
\nThe authenticated user must be an administrator for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Gets information about a suite of rule evaluations from within an organization.\nFor more information, see \"Managing rulesets for repositories in your organization.\"
", "statusCodes": [ { "httpStatusCode": "200", @@ -354163,7 +354162,8 @@ "httpStatusCode": "500", "description": "Internal Error
" } - ] + ], + "descriptionHTML": "Gets information about a suite of rule evaluations from within an organization.\nFor more information, see \"Managing rulesets for repositories in your organization.\"
" } ], "rules": [ @@ -355782,83 +355782,6 @@ } ] }, - { - "type": "object", - "name": "merge_queue", - "description": "Merges must be performed via a merge queue.
", - "isRequired": [ - "type" - ], - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "merge_queue" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "check_response_timeout_minutes", - "description": "Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed
", - "isRequired": true - }, - { - "type": "string", - "name": "grouping_strategy", - "description": "When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge.
", - "isRequired": true, - "enum": [ - "ALLGREEN", - "HEADGREEN" - ] - }, - { - "type": "integer", - "name": "max_entries_to_build", - "description": "Limit the number of queued pull requests requesting checks and workflow runs at the same time.
", - "isRequired": true - }, - { - "type": "integer", - "name": "max_entries_to_merge", - "description": "The maximum number of PRs that will be merged together in a group.
", - "isRequired": true - }, - { - "type": "string", - "name": "merge_method", - "description": "Method to use when merging changes from queued pull requests.
", - "isRequired": true, - "enum": [ - "MERGE", - "SQUASH", - "REBASE" - ] - }, - { - "type": "integer", - "name": "min_entries_to_merge", - "description": "The minimum number of PRs that will be merged together in a group.
", - "isRequired": true - }, - { - "type": "integer", - "name": "min_entries_to_merge_wait_minutes", - "description": "The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.
", - "isRequired": true - } - ] - } - ] - }, { "type": "object", "name": "required_deployments", @@ -359325,83 +359248,6 @@ } ] }, - { - "type": "object", - "name": "merge_queue", - "description": "Merges must be performed via a merge queue.
", - "isRequired": [ - "type" - ], - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "merge_queue" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "check_response_timeout_minutes", - "description": "Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed
", - "isRequired": true - }, - { - "type": "string", - "name": "grouping_strategy", - "description": "When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge.
", - "isRequired": true, - "enum": [ - "ALLGREEN", - "HEADGREEN" - ] - }, - { - "type": "integer", - "name": "max_entries_to_build", - "description": "Limit the number of queued pull requests requesting checks and workflow runs at the same time.
", - "isRequired": true - }, - { - "type": "integer", - "name": "max_entries_to_merge", - "description": "The maximum number of PRs that will be merged together in a group.
", - "isRequired": true - }, - { - "type": "string", - "name": "merge_method", - "description": "Method to use when merging changes from queued pull requests.
", - "isRequired": true, - "enum": [ - "MERGE", - "SQUASH", - "REBASE" - ] - }, - { - "type": "integer", - "name": "min_entries_to_merge", - "description": "The minimum number of PRs that will be merged together in a group.
", - "isRequired": true - }, - { - "type": "integer", - "name": "min_entries_to_merge_wait_minutes", - "description": "The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.
", - "isRequired": true - } - ] - } - ] - }, { "type": "object", "name": "required_deployments", @@ -361559,13 +361405,13 @@ } ], "previews": [], - "descriptionHTML": "Adds a team as a security manager for an organization. For more information, see \"Managing security for an organization for an organization.\"
\nThe authenticated user must be an administrator for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.
No Content
" } - ] + ], + "descriptionHTML": "Adds a team as a security manager for an organization. For more information, see \"Managing security for an organization for an organization.\"
\nThe authenticated user must be an administrator for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.
Updates the webhook configuration for an organization. To update more information about the webhook, including the active state and events, use \"Update an organization webhook .\"
You must be an organization owner to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need admin:org_hook scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
OK
" } - ] + ], + "descriptionHTML": "Updates the webhook configuration for an organization. To update more information about the webhook, including the active state and events, use \"Update an organization webhook .\"
You must be an organization owner to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need admin:org_hook scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures.
\nBuild requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes.
", "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" } - ] + ], + "descriptionHTML": "You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures.
\nBuild requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes.
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -380138,7 +379984,6 @@ } ], "previews": [], - "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nValidation failed, or the endpoint has been spammed.
" } - ] + ], + "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nLists review comments for all pull requests in a repository. By default,\nreview comments are in ascending order by ID.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.OK
" } - ] + ], + "descriptionHTML": "Lists review comments for all pull requests in a repository. By default,\nreview comments are in ascending order by ID.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.List the reactions to a team discussion.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "List the reactions to a team discussion.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Note
\n\nYou can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id.
Delete a reaction to a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
No Content
" } - ] + ], + "descriptionHTML": "Note
\n\nYou can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id.
Delete a reaction to a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Get a published release with the specified tag.
", "statusCodes": [ { "httpStatusCode": "200", @@ -438285,7 +438130,8 @@ "httpStatusCode": "404", "description": "Resource not found
" } - ] + ], + "descriptionHTML": "Get a published release with the specified tag.
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -460437,13 +460283,13 @@ } ], "previews": [], - "descriptionHTML": "Disables dependency alerts for a repository.\nThe authenticated user must have admin access to the repository. For more information,\nsee \"About security alerts for vulnerable dependencies\".
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } - ] + ], + "descriptionHTML": "Disables dependency alerts for a repository.\nThe authenticated user must have admin access to the repository. For more information,\nsee \"About security alerts for vulnerable dependencies\".
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -514063,13 +513909,13 @@ } ], "previews": [], - "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nNo Content
" } - ] + ], + "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nList all comments on a team discussion.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "List all comments on a team discussion.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Get a specific comment on a team discussion.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Get a specific comment on a team discussion.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Edits the body text of a discussion comment.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Edits the body text of a discussion comment.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Creates a new discussion post on a team's page.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"
\nNote
\n\nYou can also specify a team by org_id and team_id using the route POST /organizations/{org_id}/team/{team_id}/discussions.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Created
" } - ] + ], + "descriptionHTML": "Creates a new discussion post on a team's page.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"
\nNote
\n\nYou can also specify a team by org_id and team_id using the route POST /organizations/{org_id}/team/{team_id}/discussions.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Lists a connection between a team and an external group.
\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"GitHub's products\" in the GitHub Help documentation.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ] + ], + "descriptionHTML": "Lists a connection between a team and an external group.
\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"GitHub's products\" in the GitHub Help documentation.
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -531728,13 +531574,13 @@ } ], "previews": [], - "descriptionHTML": "Deletes a connection between a team and an external group.
\nYou can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } - ] + ], + "descriptionHTML": "Deletes a connection between a team and an external group.
\nYou can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
" } ], "members": [ diff --git a/src/rest/data/ghes-3.16-2022-11-28/schema.json b/src/rest/data/ghes-3.16-2022-11-28/schema.json index d13aba38b6ba..992c9b4d17b8 100644 --- a/src/rest/data/ghes-3.16-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.16-2022-11-28/schema.json @@ -2836,13 +2836,13 @@ } ], "previews": [], - "descriptionHTML": "Lists the organizations that are selected to have GitHub Actions enabled in an enterprise. To use this endpoint, the enterprise permission policy for enabled_organizations must be configured to selected. For more information, see \"Set GitHub Actions permissions for an enterprise.\"
OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Lists the organizations that are selected to have GitHub Actions enabled in an enterprise. To use this endpoint, the enterprise permission policy for enabled_organizations must be configured to selected. For more information, see \"Set GitHub Actions permissions for an enterprise.\"
OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
Replaces the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for enabled_organizations must be configured to selected. For more information, see \"Set GitHub Actions permissions for an enterprise.\"
OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
No Content
" } - ] + ], + "descriptionHTML": "Replaces the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for enabled_organizations must be configured to selected. For more information, see \"Set GitHub Actions permissions for an enterprise.\"
OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"
OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"
OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"
OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
No Content
" } - ] + ], + "descriptionHTML": "Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"
OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Removes a repository from the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"
OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
No Content
" } - ] + ], + "descriptionHTML": "Removes a repository from the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"
OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Gets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in an organization,\nas well as whether GitHub Actions can submit approving pull request reviews. For more information, see\n\"Setting the permissions of the GITHUB_TOKEN for your organization.\"
OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Gets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in an organization,\nas well as whether GitHub Actions can submit approving pull request reviews. For more information, see\n\"Setting the permissions of the GITHUB_TOKEN for your organization.\"
OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions in the repository.
\nIf the repository belongs to an organization or enterprise that has set restrictive permissions at the organization or enterprise levels, such as allowed_actions to selected actions, then you cannot override them for the repository.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
No Content
" } - ] + ], + "descriptionHTML": "Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions in the repository.
\nIf the repository belongs to an organization or enterprise that has set restrictive permissions at the organization or enterprise levels, such as allowed_actions to selected actions, then you cannot override them for the repository.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Lists all repositories that have been selected when the visibility\nfor repository access to a secret is set to selected.
Authenticated users must have collaborator access to a repository to create, update, or read secrets.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.
OK
" } - ] + ], + "descriptionHTML": "Lists all repositories that have been selected when the visibility\nfor repository access to a secret is set to selected.
Authenticated users must have collaborator access to a repository to create, update, or read secrets.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.
Gets a single environment secret without revealing its encrypted value.
\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
\nOAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Gets a single environment secret without revealing its encrypted value.
\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
\nOAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Deletes a self-hosted runner group for an enterprise.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
No Content
" } - ] + ], + "descriptionHTML": "Deletes a self-hosted runner group for an enterprise.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have visibility set to selected. For more information, see \"Create a self-hosted runner group for an enterprise.\"
OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
No Content
" } - ] + ], + "descriptionHTML": "Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have visibility set to selected. For more information, see \"Create a self-hosted runner group for an enterprise.\"
OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have visibility set to selected. For more information, see \"Create a self-hosted runner group for an enterprise.\"
OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
No Content
" } - ] + ], + "descriptionHTML": "Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have visibility set to selected. For more information, see \"Create a self-hosted runner group for an enterprise.\"
OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
Adds a self-hosted runner to a runner group configured in an organization.
\nOAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
No Content
" } - ] + ], + "descriptionHTML": "Adds a self-hosted runner to a runner group configured in an organization.
\nOAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Lists binaries for the runner application that you can download and run.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Lists binaries for the runner application that you can download and run.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
Returns a token that you can pass to the config script. The token expires after one hour.
Example using registration token:
\nConfigure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.
./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
Created
" } - ] + ], + "descriptionHTML": "Returns a token that you can pass to the config script. The token expires after one hour.
Example using registration token:
\nConfigure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.
./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
Gets a specific self-hosted runner configured in an organization.
\nAuthenticated users must have admin access to the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.
OK
" } - ] + ], + "descriptionHTML": "Gets a specific self-hosted runner configured in an organization.
\nAuthenticated users must have admin access to the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.
Returns a token that you can pass to the config script. The token expires after one hour.
For example, you can replace TOKEN in the following example with the registration token provided by this endpoint to configure your self-hosted runner:
./config.sh --url https://github.com/octo-org --token TOKEN\nAuthenticated users must have admin access to the repository to use this endpoint.
\nOAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Created
" } - ] + ], + "descriptionHTML": "Returns a token that you can pass to the config script. The token expires after one hour.
For example, you can replace TOKEN in the following example with the registration token provided by this endpoint to configure your self-hosted runner:
./config.sh --url https://github.com/octo-org --token TOKEN\nAuthenticated users must have admin access to the repository to use this endpoint.
\nOAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Updates an organization variable that you can reference in a GitHub Actions workflow.
\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.
No Content
" } - ] + ], + "descriptionHTML": "Updates an organization variable that you can reference in a GitHub Actions workflow.
\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.
Lists all environment variables.
\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Lists all environment variables.
\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Create an environment variable that you can reference in a GitHub Actions workflow.
\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
\nOAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Created
" } - ] + ], + "descriptionHTML": "Create an environment variable that you can reference in a GitHub Actions workflow.
\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
\nOAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Lists the people watching the specified repository.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ] + ], + "descriptionHTML": "Lists the people watching the specified repository.
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -102529,13 +102529,13 @@ } ], "previews": [], - "descriptionHTML": "Enables an authenticated GitHub App to find the user’s installation information.
\nYou must use a JWT to access this endpoint.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ] + ], + "descriptionHTML": "Enables an authenticated GitHub App to find the user’s installation information.
\nYou must use a JWT to access this endpoint.
" } ], "installations": [ @@ -106334,7 +106334,6 @@ } ], "previews": [], - "descriptionHTML": "OAuth and GitHub application owners can revoke a grant for their application and a specific user. You must provide a valid OAuth access_token as an input parameter and the grant for the token's owner will be deleted.\nDeleting an application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on the application authorizations settings screen within GitHub.
Validation failed, or the endpoint has been spammed.
" } - ] + ], + "descriptionHTML": "OAuth and GitHub application owners can revoke a grant for their application and a specific user. You must provide a valid OAuth access_token as an input parameter and the grant for the token's owner will be deleted.\nDeleting an application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on the application authorizations settings screen within GitHub.
Creates a code security configuration in an organization.
\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.
Note
\n\nOnly installed security products may be specified in the request body. Specifying an uninstalled security product will result in a validation error.
\nSuccessfully created code security configuration
" } - ] + ], + "descriptionHTML": "Creates a code security configuration in an organization.
\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.
Note
\n\nOnly installed security products may be specified in the request body. Specifying an uninstalled security product will result in a validation error.
\nDeletes a secret in an organization using the secret name.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
No Content
" } - ] + ], + "descriptionHTML": "Deletes a secret in an organization using the secret name.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -200127,13 +200127,13 @@ } ], "previews": [], - "descriptionHTML": "Lists the deployment branch policies for an environment.
\nAnyone with read access to the repository can use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.
OK
" } - ] + ], + "descriptionHTML": "Lists the deployment branch policies for an environment.
\nAnyone with read access to the repository can use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.
OK
" } - ] + ], + "descriptionHTML": "" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -209213,13 +209213,13 @@ } ], "previews": [], - "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ] + ], + "descriptionHTML": "" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -210320,13 +210320,13 @@ } ], "previews": [], - "descriptionHTML": "Retrieves the audit log streaming public key for encrypting secrets.
\nWhen using this endpoint, you must encrypt the credentials following the same encryption steps as outlined in the guide on encrypting secrets. See \"Encrypting secrets for the REST API.\"
", "statusCodes": [ { "httpStatusCode": "200", "description": "The stream key for the audit log streaming configuration was retrieved successfully.
" } - ] + ], + "descriptionHTML": "Retrieves the audit log streaming public key for encrypting secrets.
\nWhen using this endpoint, you must encrypt the credentials following the same encryption steps as outlined in the guide on encrypting secrets. See \"Encrypting secrets for the REST API.\"
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -210891,13 +210891,13 @@ } ], "previews": [], - "descriptionHTML": "Creates an audit log streaming configuration for any of the supported streaming endpoints: Azure Blob Storage, Azure Event Hubs, Amazon S3, Splunk, Google Cloud Storage, Datadog.
\nWhen using this endpoint, you must encrypt the credentials following the same encryption steps as outlined in the guide on encrypting secrets. See \"Encrypting secrets for the REST API.\"
", "statusCodes": [ { "httpStatusCode": "200", "description": "The audit log stream configuration was created successfully.
" } - ] + ], + "descriptionHTML": "Creates an audit log streaming configuration for any of the supported streaming endpoints: Azure Blob Storage, Azure Event Hubs, Amazon S3, Splunk, Google Cloud Storage, Datadog.
\nWhen using this endpoint, you must encrypt the credentials following the same encryption steps as outlined in the guide on encrypting secrets. See \"Encrypting secrets for the REST API.\"
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -211541,13 +211541,13 @@ } ], "previews": [], - "descriptionHTML": "Deletes an existing audit log stream configuration for an enterprise.
\nWhen using this endpoint, you must encrypt the credentials following the same encryption steps as outlined in the guide on encrypting secrets. See \"Encrypting secrets for the REST API.\"
", "statusCodes": [ { "httpStatusCode": "204", "description": "The audit log stream configuration was deleted successfully.
" } - ] + ], + "descriptionHTML": "Deletes an existing audit log stream configuration for an enterprise.
\nWhen using this endpoint, you must encrypt the credentials following the same encryption steps as outlined in the guide on encrypting secrets. See \"Encrypting secrets for the REST API.\"
" } ], "billing": [ @@ -211738,13 +211738,13 @@ } ], "previews": [], - "descriptionHTML": "Gets the GitHub Advanced Security active committers for an enterprise per repository.
\nEach distinct user login across all repositories is counted as a single Advanced Security seat, so the total_advanced_security_committers is not the sum of active_users for each repository.
The total number of repositories with committer information is tracked by the total_count field.
Success
" } - ] + ], + "descriptionHTML": "Gets the GitHub Advanced Security active committers for an enterprise per repository.
\nEach distinct user login across all repositories is counted as a single Advanced Security seat, so the total_advanced_security_committers is not the sum of active_users for each repository.
The total number of repositories with committer information is tracked by the total_count field.
Uploads a new enterprise license. In order to apply it right away, use the apply query parameter.
Note
\n\nThe request body for this operation must be submitted as multipart/form-data data. You can can reference the license file by prefixing the filename with the @ symbol using curl. For more information, see the curl documentation.
Internal error
" } - ] + ], + "descriptionHTML": "Uploads a new enterprise license. In order to apply it right away, use the apply query parameter.
Note
\n\nThe request body for this operation must be submitted as multipart/form-data data. You can can reference the license file by prefixing the filename with the @ symbol using curl. For more information, see the curl documentation.
OK
" } - ] + ], + "descriptionHTML": "" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -216511,13 +216511,13 @@ } ], "previews": [], - "descriptionHTML": "For pre-receive hooks which are allowed to be configured at the org level, you can set enforcement and allow_downstream_configuration
OK
" } - ] + ], + "descriptionHTML": "For pre-receive hooks which are allowed to be configured at the org level, you can set enforcement and allow_downstream_configuration
In addition to seeing the download status at the \"Get a pre-receive environment\" endpoint, there is also this separate endpoint for just the download status.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ] + ], + "descriptionHTML": "In addition to seeing the download status at the \"Get a pre-receive environment\" endpoint, there is also this separate endpoint for just the download status.
" } ], "pre-receive-hooks": [ @@ -244920,7 +244920,6 @@ } ], "previews": [], - "descriptionHTML": "Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then create the refs/tags/[tag] reference. If you want to create a lightweight tag, you only have to create the tag reference - this call would be unnecessary.
Signature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
verified_at | string | The date the signature was verified by GitHub. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on their account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
Validation failed, or the endpoint has been spammed.
" } - ] + ], + "descriptionHTML": "Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then create the refs/tags/[tag] reference. If you want to create a lightweight tag, you only have to create the tag reference - this call would be unnecessary.
Signature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
verified_at | string | The date the signature was verified by GitHub. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on their account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced.
", "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" } - ] + ], + "descriptionHTML": "Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced.
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -303659,13 +303659,13 @@ } ], "previews": [], - "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ] + ], + "descriptionHTML": "" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -303736,7 +303736,6 @@ } ], "previews": [], - "descriptionHTML": "Deletes a milestone using the given milestone number.
", "statusCodes": [ { "httpStatusCode": "204", @@ -303746,7 +303745,8 @@ "httpStatusCode": "404", "description": "Resource not found
" } - ] + ], + "descriptionHTML": "Deletes a milestone using the given milestone number.
" } ], "timeline": [ @@ -350707,13 +350707,13 @@ } ], "previews": [], - "descriptionHTML": "Removes the public membership for the authenticated user from the specified organization, unless public visibility is enforced by default.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } - ] + ], + "descriptionHTML": "Removes the public membership for the authenticated user from the specified organization, unless public visibility is enforced by default.
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -361112,83 +361112,6 @@ } ] }, - { - "type": "object", - "name": "merge_queue", - "description": "Merges must be performed via a merge queue.
", - "isRequired": [ - "type" - ], - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "merge_queue" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "check_response_timeout_minutes", - "description": "Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed
", - "isRequired": true - }, - { - "type": "string", - "name": "grouping_strategy", - "description": "When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge.
", - "isRequired": true, - "enum": [ - "ALLGREEN", - "HEADGREEN" - ] - }, - { - "type": "integer", - "name": "max_entries_to_build", - "description": "Limit the number of queued pull requests requesting checks and workflow runs at the same time.
", - "isRequired": true - }, - { - "type": "integer", - "name": "max_entries_to_merge", - "description": "The maximum number of PRs that will be merged together in a group.
", - "isRequired": true - }, - { - "type": "string", - "name": "merge_method", - "description": "Method to use when merging changes from queued pull requests.
", - "isRequired": true, - "enum": [ - "MERGE", - "SQUASH", - "REBASE" - ] - }, - { - "type": "integer", - "name": "min_entries_to_merge", - "description": "The minimum number of PRs that will be merged together in a group.
", - "isRequired": true - }, - { - "type": "integer", - "name": "min_entries_to_merge_wait_minutes", - "description": "The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.
", - "isRequired": true - } - ] - } - ] - }, { "type": "object", "name": "required_deployments", @@ -364658,83 +364581,6 @@ } ] }, - { - "type": "object", - "name": "merge_queue", - "description": "Merges must be performed via a merge queue.
", - "isRequired": [ - "type" - ], - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "merge_queue" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "check_response_timeout_minutes", - "description": "Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed
", - "isRequired": true - }, - { - "type": "string", - "name": "grouping_strategy", - "description": "When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge.
", - "isRequired": true, - "enum": [ - "ALLGREEN", - "HEADGREEN" - ] - }, - { - "type": "integer", - "name": "max_entries_to_build", - "description": "Limit the number of queued pull requests requesting checks and workflow runs at the same time.
", - "isRequired": true - }, - { - "type": "integer", - "name": "max_entries_to_merge", - "description": "The maximum number of PRs that will be merged together in a group.
", - "isRequired": true - }, - { - "type": "string", - "name": "merge_method", - "description": "Method to use when merging changes from queued pull requests.
", - "isRequired": true, - "enum": [ - "MERGE", - "SQUASH", - "REBASE" - ] - }, - { - "type": "integer", - "name": "min_entries_to_merge", - "description": "The minimum number of PRs that will be merged together in a group.
", - "isRequired": true - }, - { - "type": "integer", - "name": "min_entries_to_merge_wait_minutes", - "description": "The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.
", - "isRequired": true - } - ] - } - ] - }, { "type": "object", "name": "required_deployments", @@ -366829,13 +366675,13 @@ } ], "previews": [], - "descriptionHTML": "Warning
\n\nClosing down notice: This operation is closing down and will be removed in Enterprise Server 3.20. Please use the \"Organization Roles\" endpoints instead.
\nOK
" } - ] + ], + "descriptionHTML": "Warning
\n\nClosing down notice: This operation is closing down and will be removed in Enterprise Server 3.20. Please use the \"Organization Roles\" endpoints instead.
\nWarning
\n\nClosing down notice: This operation is closing down and will be removed in Enterprise Server 3.20. Please use the \"Organization Roles\" endpoints instead.
\nNo Content
" } - ] + ], + "descriptionHTML": "Warning
\n\nClosing down notice: This operation is closing down and will be removed in Enterprise Server 3.20. Please use the \"Organization Roles\" endpoints instead.
\nWarning
\n\nClosing down notice: This operation is closing down and will be removed in Enterprise Server 3.20. Please use the \"Organization Roles\" endpoints instead.
\nNo Content
" } - ] + ], + "descriptionHTML": "Warning
\n\nClosing down notice: This operation is closing down and will be removed in Enterprise Server 3.20. Please use the \"Organization Roles\" endpoints instead.
\nYou can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures.
\nBuild requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes.
", "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" } - ] + ], + "descriptionHTML": "You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures.
\nBuild requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes.
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -384346,13 +384192,13 @@ } ], "previews": [], - "descriptionHTML": "Gets information about the single most recent build of a GitHub Enterprise Server Pages site.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Gets information about the single most recent build of a GitHub Enterprise Server Pages site.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using LibSodium. For more information, see \"Encrypting secrets for the REST API.\"
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Validation failed, or the endpoint has been spammed.
" } - ] + ], + "descriptionHTML": "Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using LibSodium. For more information, see \"Encrypting secrets for the REST API.\"
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Note
\n\nYou can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id.
Delete a reaction to a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
No Content
" } - ] + ], + "descriptionHTML": "Note
\n\nYou can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id.
Delete a reaction to a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Note
\n\nYou can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id.
Delete a reaction to an issue.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } - ] + ], + "descriptionHTML": "Note
\n\nYou can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id.
Delete a reaction to an issue.
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -440314,13 +440175,13 @@ } ], "previews": [], - "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new \"Create reaction for a team discussion comment\" endpoint.
\nCreate a reaction to a team discussion comment.
\nA response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Created
" } - ] + ], + "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new \"Create reaction for a team discussion comment\" endpoint.
\nCreate a reaction to a team discussion comment.
\nA response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ] + ], + "descriptionHTML": "Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language.
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -471080,13 +470941,13 @@ } } ], - "descriptionHTML": "Creates a new repository using a repository template. Use the template_owner and template_repo route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the Get a repository endpoint and check that the is_template key is true.
OAuth app tokens and personal access tokens (classic) need the public_repo or repo scope to create a public repository, and repo scope to create a private repository.
Created
" } ], + "descriptionHTML": "Creates a new repository using a repository template. Use the template_owner and template_repo route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the Get a repository endpoint and check that the is_template key is true.
OAuth app tokens and personal access tokens (classic) need the public_repo or repo scope to create a public repository, and repo scope to create a private repository.
Creating and using repository templates is currently available for developers to preview. To access this new endpoint during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.baptiste-preview+json\nGets all autolinks that are configured for a repository.
\nInformation about autolinks are only available to repository administrators.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ] + ], + "descriptionHTML": "Gets all autolinks that are configured for a repository.
\nInformation about autolinks are only available to repository administrators.
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -500912,7 +500773,6 @@ } ], "previews": [], - "descriptionHTML": "This will trigger a ping event to be sent to the hook.
", "statusCodes": [ { "httpStatusCode": "204", @@ -500922,7 +500782,8 @@ "httpStatusCode": "404", "description": "Resource not found
" } - ] + ], + "descriptionHTML": "This will trigger a ping event to be sent to the hook.
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -531500,13 +531361,13 @@ } ], "previews": [], - "descriptionHTML": "Creates a new comment on a team discussion.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"
\nNote
\n\nYou can also specify a team by org_id and team_id using the route POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Created
" } - ] + ], + "descriptionHTML": "Creates a new comment on a team discussion.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"
\nNote
\n\nYou can also specify a team by org_id and team_id using the route POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Deletes a comment on a team discussion.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
No Content
" } - ] + ], + "descriptionHTML": "Deletes a comment on a team discussion.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Creates a connection between a team and an external group. Only one external group can be linked to a team.
\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"GitHub's products\" in the GitHub Help documentation.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ] + ], + "descriptionHTML": "Creates a connection between a team and an external group. Only one external group can be linked to a team.
\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"GitHub's products\" in the GitHub Help documentation.
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", diff --git a/src/rest/data/ghes-3.17-2022-11-28/schema.json b/src/rest/data/ghes-3.17-2022-11-28/schema.json index febff2d78999..661dbdef9454 100644 --- a/src/rest/data/ghes-3.17-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.17-2022-11-28/schema.json @@ -1080,13 +1080,13 @@ } ], "previews": [], + "descriptionHTML": "Gets the GitHub Actions cache usage policy for an enterprise.
\nOAuth tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Gets the GitHub Actions cache usage policy for an enterprise.
\nOAuth tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
Gets the selected actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for an enterprise.\"
OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Gets the selected actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for an enterprise.\"
OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
Sets the actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for an enterprise.\"
OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Sets the actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for an enterprise.\"
OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
Sets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in an enterprise, and sets\nwhether GitHub Actions can submit approving pull request reviews. For more information, see\n\"Enforcing a policy for workflow permissions in your enterprise.\"
OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
Success response
" } - ], - "descriptionHTML": "Sets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in an enterprise, and sets\nwhether GitHub Actions can submit approving pull request reviews. For more information, see\n\"Enforcing a policy for workflow permissions in your enterprise.\"
OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
Gets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in an organization,\nas well as whether GitHub Actions can submit approving pull request reviews. For more information, see\n\"Setting the permissions of the GITHUB_TOKEN for your organization.\"
OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Gets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in an organization,\nas well as whether GitHub Actions can submit approving pull request reviews. For more information, see\n\"Setting the permissions of the GITHUB_TOKEN for your organization.\"
OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.
\nAnyone with read access to the repository can use this endpoint.
\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.
\nAnyone with read access to the repository can use this endpoint.
\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Creates a new self-hosted runner group for an enterprise.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
Created
" } - ], - "descriptionHTML": "Creates a new self-hosted runner group for an enterprise.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
Lists the self-hosted runners that are in a specific enterprise group.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Lists the self-hosted runners that are in a specific enterprise group.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
Lists all self-hosted runners configured for an enterprise.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Lists all self-hosted runners configured for an enterprise.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
Returns a token that you can pass to the config script. The token expires after one hour.
For example, you can replace TOKEN in the following example with the registration token provided by this endpoint to configure your self-hosted runner:
./config.sh --url https://github.com/octo-org --token TOKEN\nAuthenticated users must have admin access to the organization to use this endpoint.
\nOAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Created
" } - ], - "descriptionHTML": "Returns a token that you can pass to the config script. The token expires after one hour.
For example, you can replace TOKEN in the following example with the registration token provided by this endpoint to configure your self-hosted runner:
./config.sh --url https://github.com/octo-org --token TOKEN\nAuthenticated users must have admin access to the organization to use this endpoint.
\nOAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Anyone with read access to the repository can use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.
OK
" } - ], - "descriptionHTML": "Anyone with read access to the repository can use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.
Cancels a workflow run and bypasses conditions that would otherwise cause a workflow execution to continue, such as an always() condition on a job.\nYou should only use this endpoint to cancel a workflow run when the workflow run is not responding to POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel.
OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Conflict
" } - ], - "descriptionHTML": "Cancels a workflow run and bypasses conditions that would otherwise cause a workflow execution to continue, such as an always() condition on a job.\nYou should only use this endpoint to cancel a workflow run when the workflow run is not responding to POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel.
OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
This is the user's organization dashboard. You must be authenticated as the user to view this.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nOK
" } - ], - "descriptionHTML": "This is the user's organization dashboard. You must be authenticated as the user to view this.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nLists repositories a user has starred.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.star+json: Includes a timestamp of when the star was created.OK
" } - ], - "descriptionHTML": "Lists repositories a user has starred.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.star+json: Includes a timestamp of when the star was created.Revokes the installation token you're using to authenticate as an installation and access this endpoint.
\nOnce an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the \"Create an installation access token for an app\" endpoint.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } - ], - "descriptionHTML": "Revokes the installation token you're using to authenticate as an installation and access this endpoint.
\nOnce an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the \"Create an installation access token for an app\" endpoint.
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -109664,13 +109664,13 @@ } ], "previews": [], + "descriptionHTML": "Gets the GitHub Advanced Security active committers for an organization per repository.
\nEach distinct user login across all repositories is counted as a single Advanced Security seat, so the total_advanced_security_committers is not the sum of advanced_security_committers for each repository.
If this organization defers to an enterprise for billing, the total_advanced_security_committers returned from the organization API may include some users that are in more than one organization, so they will only consume a single Advanced Security seat at the enterprise level.
The total number of repositories with committer information is tracked by the total_count field.
Success
" } - ], - "descriptionHTML": "Gets the GitHub Advanced Security active committers for an organization per repository.
\nEach distinct user login across all repositories is counted as a single Advanced Security seat, so the total_advanced_security_committers is not the sum of advanced_security_committers for each repository.
If this organization defers to an enterprise for billing, the total_advanced_security_committers returned from the organization API may include some users that are in more than one organization, so they will only consume a single Advanced Security seat at the enterprise level.
The total number of repositories with committer information is tracked by the total_count field.
OK
" } - ], - "descriptionHTML": "" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -211037,13 +211037,13 @@ } ], "previews": [], + "descriptionHTML": "Gets the audit log for an enterprise.
\nThe authenticated user must be an enterprise admin to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Gets the audit log for an enterprise.
\nThe authenticated user must be an enterprise admin to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
Retrieves the audit log streaming public key for encrypting secrets.
\nWhen using this endpoint, you must encrypt the credentials following the same encryption steps as outlined in the guide on encrypting secrets. See \"Encrypting secrets for the REST API.\"
", "statusCodes": [ { "httpStatusCode": "200", "description": "The stream key for the audit log streaming configuration was retrieved successfully.
" } - ], - "descriptionHTML": "Retrieves the audit log streaming public key for encrypting secrets.
\nWhen using this endpoint, you must encrypt the credentials following the same encryption steps as outlined in the guide on encrypting secrets. See \"Encrypting secrets for the REST API.\"
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -215707,6 +215707,7 @@ } ], "previews": [], + "descriptionHTML": "Get node metadata for all configured nodes in the current cluster. For more information, see \"About clustering.\"
", "statusCodes": [ { "httpStatusCode": "200", @@ -215720,8 +215721,7 @@ "httpStatusCode": "500", "description": "Internal error
" } - ], - "descriptionHTML": "Get node metadata for all configured nodes in the current cluster. For more information, see \"About clustering.\"
" + ] }, { "serverUrl": "http(s)://HOSTNAME", @@ -219546,13 +219546,13 @@ } ], "previews": [], + "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -356710,13 +356710,13 @@ } ], "previews": [], + "descriptionHTML": "List all users who are outside collaborators of an organization.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "List all users who are outside collaborators of an organization.
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -362653,83 +362653,6 @@ } ] }, - { - "type": "object", - "name": "merge_queue", - "description": "Merges must be performed via a merge queue.
", - "isRequired": [ - "type" - ], - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "merge_queue" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "check_response_timeout_minutes", - "description": "Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed
", - "isRequired": true - }, - { - "type": "string", - "name": "grouping_strategy", - "description": "When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge.
", - "isRequired": true, - "enum": [ - "ALLGREEN", - "HEADGREEN" - ] - }, - { - "type": "integer", - "name": "max_entries_to_build", - "description": "Limit the number of queued pull requests requesting checks and workflow runs at the same time.
", - "isRequired": true - }, - { - "type": "integer", - "name": "max_entries_to_merge", - "description": "The maximum number of PRs that will be merged together in a group.
", - "isRequired": true - }, - { - "type": "string", - "name": "merge_method", - "description": "Method to use when merging changes from queued pull requests.
", - "isRequired": true, - "enum": [ - "MERGE", - "SQUASH", - "REBASE" - ] - }, - { - "type": "integer", - "name": "min_entries_to_merge", - "description": "The minimum number of PRs that will be merged together in a group.
", - "isRequired": true - }, - { - "type": "integer", - "name": "min_entries_to_merge_wait_minutes", - "description": "The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.
", - "isRequired": true - } - ] - } - ] - }, { "type": "object", "name": "required_deployments", @@ -366600,83 +366523,6 @@ } ] }, - { - "type": "object", - "name": "merge_queue", - "description": "Merges must be performed via a merge queue.
", - "isRequired": [ - "type" - ], - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "merge_queue" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "check_response_timeout_minutes", - "description": "Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed
", - "isRequired": true - }, - { - "type": "string", - "name": "grouping_strategy", - "description": "When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge.
", - "isRequired": true, - "enum": [ - "ALLGREEN", - "HEADGREEN" - ] - }, - { - "type": "integer", - "name": "max_entries_to_build", - "description": "Limit the number of queued pull requests requesting checks and workflow runs at the same time.
", - "isRequired": true - }, - { - "type": "integer", - "name": "max_entries_to_merge", - "description": "The maximum number of PRs that will be merged together in a group.
", - "isRequired": true - }, - { - "type": "string", - "name": "merge_method", - "description": "Method to use when merging changes from queued pull requests.
", - "isRequired": true, - "enum": [ - "MERGE", - "SQUASH", - "REBASE" - ] - }, - { - "type": "integer", - "name": "min_entries_to_merge", - "description": "The minimum number of PRs that will be merged together in a group.
", - "isRequired": true - }, - { - "type": "integer", - "name": "min_entries_to_merge_wait_minutes", - "description": "The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.
", - "isRequired": true - } - ] - } - ] - }, { "type": "object", "name": "required_deployments", @@ -374883,13 +374729,13 @@ } ], "previews": [], + "descriptionHTML": "Gets a specific package in an organization.
\nOAuth app tokens and personal access tokens (classic) need the read:packages scope to use this endpoint. For more information, see \"About permissions for GitHub Packages.\"
OK
" } - ], - "descriptionHTML": "Gets a specific package in an organization.
\nOAuth app tokens and personal access tokens (classic) need the read:packages scope to use this endpoint. For more information, see \"About permissions for GitHub Packages.\"
Gets a specific package version in an organization.
\nOAuth app tokens and personal access tokens (classic) need the read:packages scope to use this endpoint. For more information, see \"About permissions for GitHub Packages.\"
OK
" } - ], - "descriptionHTML": "Gets a specific package version in an organization.
\nOAuth app tokens and personal access tokens (classic) need the read:packages scope to use this endpoint. For more information, see \"About permissions for GitHub Packages.\"
Lists builts of a GitHub Enterprise Server Pages site.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Lists builts of a GitHub Enterprise Server Pages site.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Lists all review comments for a specified pull request. By default, review comments\nare in ascending order by ID.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.OK
" } - ], - "descriptionHTML": "Lists all review comments for a specified pull request. By default, review comments\nare in ascending order by ID.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.List the reactions to a pull request review comment.
", "statusCodes": [ { "httpStatusCode": "200", @@ -440163,8 +440025,7 @@ "httpStatusCode": "404", "description": "Resource not found
" } - ], - "descriptionHTML": "List the reactions to a pull request review comment.
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -442301,13 +442162,13 @@ } ], "previews": [], + "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion comment endpoint.
List the reactions to a team discussion comment.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion comment endpoint.
List the reactions to a team discussion comment.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Lists a team's repositories visible to the authenticated user.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/repos.
OK
" } - ], - "descriptionHTML": "Lists a team's repositories visible to the authenticated user.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/repos.
Deletes a comment on a team discussion.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Deletes a comment on a team discussion.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete a discussion endpoint.
Delete a discussion from a team's page.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete a discussion endpoint.
Delete a discussion from a team's page.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.