Add decorated OpenAPI schema files
This commit is contained in:
github-openapi-bot
@@ -1133,6 +1133,7 @@
|
||||
"requestPath": "/repos/{owner}/{repo}/dependabot/secrets/{secret_name}"
|
||||
}
|
||||
],
|
||||
"dependency-graph": [],
|
||||
"deploy_keys": [
|
||||
{
|
||||
"slug": "list-deploy-keys",
|
||||
|
||||
@@ -3999,7 +3999,7 @@
|
||||
"httpStatusCode": "200",
|
||||
"httpStatusMessage": "OK",
|
||||
"description": "<p>Response</p>",
|
||||
"payload": "{\n \"total_count\": 3,\n \"runner_groups\": [\n {\n \"id\": 1,\n \"name\": \"Default\",\n \"visibility\": \"all\",\n \"default\": true,\n \"runners_url\": \"https://api.github.com/enterprises/octo-corp/actions/runner_groups/1/runners\",\n \"allows_public_repositories\": false\n },\n {\n \"id\": 2,\n \"name\": \"octo-runner-group\",\n \"visibility\": \"selected\",\n \"default\": false,\n \"selected_organizations_url\": \"https://api.github.com/enterprises/octo-corp/actions/runner_groups/2/organizations\",\n \"runners_url\": \"https://api.github.com/enterprises/octo-corp/actions/runner_groups/2/runners\",\n \"allows_public_repositories\": true\n },\n {\n \"id\": 3,\n \"name\": \"expensive-hardware\",\n \"visibility\": \"private\",\n \"default\": false,\n \"runners_url\": \"https://api.github.com/enterprises/octo-corp/actions/runner_groups/3/runners\",\n \"allows_public_repositories\": true\n }\n ]\n}"
|
||||
"payload": "{\n \"total_count\": 3,\n \"runner_groups\": [\n {\n \"id\": 1,\n \"name\": \"Default\",\n \"visibility\": \"all\",\n \"default\": true,\n \"runners_url\": \"https://api.github.com/enterprises/octo-corp/actions/runner_groups/1/runners\",\n \"allows_public_repositories\": false,\n \"restricted_to_workflows\": false,\n \"selected_workflows\": [],\n \"workflow_restrictions_read_only\": false\n },\n {\n \"id\": 2,\n \"name\": \"octo-runner-group\",\n \"visibility\": \"selected\",\n \"default\": false,\n \"selected_organizations_url\": \"https://api.github.com/enterprises/octo-corp/actions/runner_groups/2/organizations\",\n \"runners_url\": \"https://api.github.com/enterprises/octo-corp/actions/runner_groups/2/runners\",\n \"allows_public_repositories\": true,\n \"restricted_to_workflows\": true,\n \"selected_workflows\": [\n \"octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main\"\n ],\n \"workflow_restrictions_read_only\": false\n },\n {\n \"id\": 3,\n \"name\": \"expensive-hardware\",\n \"visibility\": \"private\",\n \"default\": false,\n \"runners_url\": \"https://api.github.com/enterprises/octo-corp/actions/runner_groups/3/runners\",\n \"allows_public_repositories\": true,\n \"restricted_to_workflows\": false,\n \"selected_workflows\": [\n \"octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main\"\n ],\n \"workflow_restrictions_read_only\": false\n }\n ]\n}"
|
||||
}
|
||||
]
|
||||
},
|
||||
@@ -4093,6 +4093,32 @@
|
||||
"rawType": "boolean",
|
||||
"rawDescription": "Whether the runner group can be used by `public` repositories.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
"restricted_to_workflows": {
|
||||
"description": "<p>If <code>true</code>, the runner group will be restricted to running only the workflows specified in the <code>selected_workflows</code> array.</p>",
|
||||
"type": "boolean",
|
||||
"default": false,
|
||||
"name": "restricted_to_workflows",
|
||||
"in": "body",
|
||||
"rawType": "boolean",
|
||||
"rawDescription": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
"selected_workflows": {
|
||||
"description": "<p>List of workflows the runner group should be allowed to run. This setting will be ignored unless <code>restricted_to_workflows</code> is set to <code>true</code>.</p>",
|
||||
"type": "array of strings",
|
||||
"items": {
|
||||
"type": "string",
|
||||
"description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.",
|
||||
"examples": [
|
||||
"octo-org/octo-repo/.github/workflows/deploy.yaml@main"
|
||||
]
|
||||
},
|
||||
"name": "selected_workflows",
|
||||
"in": "body",
|
||||
"rawType": "array",
|
||||
"rawDescription": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.",
|
||||
"childParamsGroups": []
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
@@ -4133,7 +4159,7 @@
|
||||
"httpStatusCode": "201",
|
||||
"httpStatusMessage": "Created",
|
||||
"description": "<p>Response</p>",
|
||||
"payload": "{\n \"id\": 2,\n \"name\": \"octo-runner-group\",\n \"visibility\": \"selected\",\n \"default\": false,\n \"selected_organizations_url\": \"https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/organizations\",\n \"runners_url\": \"https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/runners\",\n \"allows_public_repositories\": false\n}"
|
||||
"payload": "{\n \"id\": 2,\n \"name\": \"octo-runner-group\",\n \"visibility\": \"selected\",\n \"default\": false,\n \"selected_organizations_url\": \"https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/organizations\",\n \"runners_url\": \"https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/runners\",\n \"allows_public_repositories\": false,\n \"restricted_to_workflows\": true,\n \"selected_workflows\": [\n \"octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main\"\n ],\n \"workflow_restrictions_read_only\": false\n}"
|
||||
}
|
||||
],
|
||||
"bodyParameters": [
|
||||
@@ -4194,6 +4220,32 @@
|
||||
"rawType": "boolean",
|
||||
"rawDescription": "Whether the runner group can be used by `public` repositories.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"description": "<p>If <code>true</code>, the runner group will be restricted to running only the workflows specified in the <code>selected_workflows</code> array.</p>",
|
||||
"type": "boolean",
|
||||
"default": false,
|
||||
"name": "restricted_to_workflows",
|
||||
"in": "body",
|
||||
"rawType": "boolean",
|
||||
"rawDescription": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"description": "<p>List of workflows the runner group should be allowed to run. This setting will be ignored unless <code>restricted_to_workflows</code> is set to <code>true</code>.</p>",
|
||||
"type": "array of strings",
|
||||
"items": {
|
||||
"type": "string",
|
||||
"description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.",
|
||||
"examples": [
|
||||
"octo-org/octo-repo/.github/workflows/deploy.yaml@main"
|
||||
]
|
||||
},
|
||||
"name": "selected_workflows",
|
||||
"in": "body",
|
||||
"rawType": "array",
|
||||
"rawDescription": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.",
|
||||
"childParamsGroups": []
|
||||
}
|
||||
]
|
||||
},
|
||||
@@ -4249,7 +4301,7 @@
|
||||
"httpStatusCode": "200",
|
||||
"httpStatusMessage": "OK",
|
||||
"description": "<p>Response</p>",
|
||||
"payload": "{\n \"id\": 2,\n \"name\": \"octo-runner-group\",\n \"visibility\": \"selected\",\n \"default\": false,\n \"selected_organizations_url\": \"https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/organizations\",\n \"runners_url\": \"https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/runners\",\n \"allows_public_repositories\": false\n}"
|
||||
"payload": "{\n \"id\": 2,\n \"name\": \"octo-runner-group\",\n \"visibility\": \"selected\",\n \"default\": false,\n \"selected_organizations_url\": \"https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/organizations\",\n \"runners_url\": \"https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/runners\",\n \"allows_public_repositories\": false,\n \"restricted_to_workflows\": true,\n \"selected_workflows\": [\n \"octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main\"\n ],\n \"workflow_restrictions_read_only\": false\n}"
|
||||
}
|
||||
]
|
||||
},
|
||||
@@ -4328,6 +4380,32 @@
|
||||
"rawType": "boolean",
|
||||
"rawDescription": "Whether the runner group can be used by `public` repositories.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
"restricted_to_workflows": {
|
||||
"description": "<p>If <code>true</code>, the runner group will be restricted to running only the workflows specified in the <code>selected_workflows</code> array.</p>",
|
||||
"type": "boolean",
|
||||
"default": false,
|
||||
"name": "restricted_to_workflows",
|
||||
"in": "body",
|
||||
"rawType": "boolean",
|
||||
"rawDescription": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
"selected_workflows": {
|
||||
"description": "<p>List of workflows the runner group should be allowed to run. This setting will be ignored unless <code>restricted_to_workflows</code> is set to <code>true</code>.</p>",
|
||||
"type": "array of strings",
|
||||
"items": {
|
||||
"type": "string",
|
||||
"description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.",
|
||||
"examples": [
|
||||
"octo-org/octo-repo/.github/workflows/deploy.yaml@main"
|
||||
]
|
||||
},
|
||||
"name": "selected_workflows",
|
||||
"in": "body",
|
||||
"rawType": "array",
|
||||
"rawDescription": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.",
|
||||
"childParamsGroups": []
|
||||
}
|
||||
}
|
||||
},
|
||||
@@ -4357,7 +4435,7 @@
|
||||
"httpStatusCode": "200",
|
||||
"httpStatusMessage": "OK",
|
||||
"description": "<p>Response</p>",
|
||||
"payload": "{\n \"id\": 2,\n \"name\": \"Expensive hardware runners\",\n \"visibility\": \"selected\",\n \"default\": false,\n \"selected_organizations_url\": \"https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/organizations\",\n \"runners_url\": \"https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/runners\",\n \"allows_public_repositories\": true\n}"
|
||||
"payload": "{\n \"id\": 2,\n \"name\": \"Expensive hardware runners\",\n \"visibility\": \"selected\",\n \"default\": false,\n \"selected_organizations_url\": \"https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/organizations\",\n \"runners_url\": \"https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/runners\",\n \"allows_public_repositories\": true,\n \"restricted_to_workflows\": false,\n \"selected_workflows\": [\n \"octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main\"\n ],\n \"workflow_restrictions_read_only\": false\n}"
|
||||
}
|
||||
],
|
||||
"bodyParameters": [
|
||||
@@ -4393,6 +4471,32 @@
|
||||
"rawType": "boolean",
|
||||
"rawDescription": "Whether the runner group can be used by `public` repositories.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"description": "<p>If <code>true</code>, the runner group will be restricted to running only the workflows specified in the <code>selected_workflows</code> array.</p>",
|
||||
"type": "boolean",
|
||||
"default": false,
|
||||
"name": "restricted_to_workflows",
|
||||
"in": "body",
|
||||
"rawType": "boolean",
|
||||
"rawDescription": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"description": "<p>List of workflows the runner group should be allowed to run. This setting will be ignored unless <code>restricted_to_workflows</code> is set to <code>true</code>.</p>",
|
||||
"type": "array of strings",
|
||||
"items": {
|
||||
"type": "string",
|
||||
"description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.",
|
||||
"examples": [
|
||||
"octo-org/octo-repo/.github/workflows/deploy.yaml@main"
|
||||
]
|
||||
},
|
||||
"name": "selected_workflows",
|
||||
"in": "body",
|
||||
"rawType": "array",
|
||||
"rawDescription": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.",
|
||||
"childParamsGroups": []
|
||||
}
|
||||
]
|
||||
},
|
||||
@@ -5130,7 +5234,7 @@
|
||||
"httpStatusCode": "200",
|
||||
"httpStatusMessage": "OK",
|
||||
"description": "<p>Response</p>",
|
||||
"payload": "{\n \"total_count\": 3,\n \"runner_groups\": [\n {\n \"id\": 1,\n \"name\": \"Default\",\n \"visibility\": \"all\",\n \"default\": true,\n \"runners_url\": \"https://api.github.com/orgs/octo-org/actions/runner_groups/1/runners\",\n \"inherited\": false,\n \"allows_public_repositories\": true\n },\n {\n \"id\": 2,\n \"name\": \"octo-runner-group\",\n \"visibility\": \"selected\",\n \"default\": false,\n \"selected_repositories_url\": \"https://api.github.com/orgs/octo-org/actions/runner_groups/2/repositories\",\n \"runners_url\": \"https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners\",\n \"inherited\": true,\n \"allows_public_repositories\": true\n },\n {\n \"id\": 3,\n \"name\": \"expensive-hardware\",\n \"visibility\": \"private\",\n \"default\": false,\n \"runners_url\": \"https://api.github.com/orgs/octo-org/actions/runner_groups/3/runners\",\n \"inherited\": false,\n \"allows_public_repositories\": true\n }\n ]\n}"
|
||||
"payload": "{\n \"total_count\": 3,\n \"runner_groups\": [\n {\n \"id\": 1,\n \"name\": \"Default\",\n \"visibility\": \"all\",\n \"default\": true,\n \"runners_url\": \"https://api.github.com/orgs/octo-org/actions/runner_groups/1/runners\",\n \"inherited\": false,\n \"allows_public_repositories\": true,\n \"restricted_to_workflows\": false,\n \"selected_workflows\": [],\n \"workflow_restrictions_read_only\": false\n },\n {\n \"id\": 2,\n \"name\": \"octo-runner-group\",\n \"visibility\": \"selected\",\n \"default\": false,\n \"selected_repositories_url\": \"https://api.github.com/orgs/octo-org/actions/runner_groups/2/repositories\",\n \"runners_url\": \"https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners\",\n \"inherited\": true,\n \"allows_public_repositories\": true,\n \"restricted_to_workflows\": true,\n \"selected_workflows\": [\n \"octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main\"\n ],\n \"workflow_restrictions_read_only\": true\n },\n {\n \"id\": 3,\n \"name\": \"expensive-hardware\",\n \"visibility\": \"private\",\n \"default\": false,\n \"runners_url\": \"https://api.github.com/orgs/octo-org/actions/runner_groups/3/runners\",\n \"inherited\": false,\n \"allows_public_repositories\": true,\n \"restricted_to_workflows\": false,\n \"selected_workflows\": [\n \"octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main\"\n ],\n \"workflow_restrictions_read_only\": false\n }\n ]\n}"
|
||||
}
|
||||
]
|
||||
},
|
||||
@@ -5225,6 +5329,32 @@
|
||||
"rawType": "boolean",
|
||||
"rawDescription": "Whether the runner group can be used by `public` repositories.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
"restricted_to_workflows": {
|
||||
"description": "<p>If <code>true</code>, the runner group will be restricted to running only the workflows specified in the <code>selected_workflows</code> array.</p>",
|
||||
"type": "boolean",
|
||||
"default": false,
|
||||
"name": "restricted_to_workflows",
|
||||
"in": "body",
|
||||
"rawType": "boolean",
|
||||
"rawDescription": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
"selected_workflows": {
|
||||
"description": "<p>List of workflows the runner group should be allowed to run. This setting will be ignored unless <code>restricted_to_workflows</code> is set to <code>true</code>.</p>",
|
||||
"type": "array of strings",
|
||||
"items": {
|
||||
"type": "string",
|
||||
"description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.",
|
||||
"examples": [
|
||||
"octo-org/octo-repo/.github/workflows/deploy.yaml@main"
|
||||
]
|
||||
},
|
||||
"name": "selected_workflows",
|
||||
"in": "body",
|
||||
"rawType": "array",
|
||||
"rawDescription": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.",
|
||||
"childParamsGroups": []
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
@@ -5265,7 +5395,7 @@
|
||||
"httpStatusCode": "201",
|
||||
"httpStatusMessage": "Created",
|
||||
"description": "<p>Response</p>",
|
||||
"payload": "{\n \"id\": 2,\n \"name\": \"octo-runner-group\",\n \"visibility\": \"selected\",\n \"default\": false,\n \"selected_repositories_url\": \"https://api.github.com/orgs/octo-org/actions/runner-groups/2/repositories\",\n \"runners_url\": \"https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners\",\n \"inherited\": false,\n \"allows_public_repositories\": true\n}"
|
||||
"payload": "{\n \"id\": 2,\n \"name\": \"octo-runner-group\",\n \"visibility\": \"selected\",\n \"default\": false,\n \"selected_repositories_url\": \"https://api.github.com/orgs/octo-org/actions/runner-groups/2/repositories\",\n \"runners_url\": \"https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners\",\n \"inherited\": false,\n \"allows_public_repositories\": true,\n \"restricted_to_workflows\": true,\n \"selected_workflows\": [\n \"octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main\"\n ],\n \"workflow_restrictions_read_only\": false\n}"
|
||||
}
|
||||
],
|
||||
"bodyParameters": [
|
||||
@@ -5328,6 +5458,32 @@
|
||||
"rawType": "boolean",
|
||||
"rawDescription": "Whether the runner group can be used by `public` repositories.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"description": "<p>If <code>true</code>, the runner group will be restricted to running only the workflows specified in the <code>selected_workflows</code> array.</p>",
|
||||
"type": "boolean",
|
||||
"default": false,
|
||||
"name": "restricted_to_workflows",
|
||||
"in": "body",
|
||||
"rawType": "boolean",
|
||||
"rawDescription": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"description": "<p>List of workflows the runner group should be allowed to run. This setting will be ignored unless <code>restricted_to_workflows</code> is set to <code>true</code>.</p>",
|
||||
"type": "array of strings",
|
||||
"items": {
|
||||
"type": "string",
|
||||
"description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.",
|
||||
"examples": [
|
||||
"octo-org/octo-repo/.github/workflows/deploy.yaml@main"
|
||||
]
|
||||
},
|
||||
"name": "selected_workflows",
|
||||
"in": "body",
|
||||
"rawType": "array",
|
||||
"rawDescription": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.",
|
||||
"childParamsGroups": []
|
||||
}
|
||||
]
|
||||
},
|
||||
@@ -5382,7 +5538,7 @@
|
||||
"httpStatusCode": "200",
|
||||
"httpStatusMessage": "OK",
|
||||
"description": "<p>Response</p>",
|
||||
"payload": "{\n \"id\": 2,\n \"name\": \"octo-runner-group\",\n \"visibility\": \"selected\",\n \"default\": false,\n \"selected_repositories_url\": \"https://api.github.com/orgs/octo-org/actions/runner_groups/2/repositories\",\n \"runners_url\": \"https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners\",\n \"inherited\": false,\n \"allows_public_repositories\": true\n}"
|
||||
"payload": "{\n \"id\": 2,\n \"name\": \"octo-runner-group\",\n \"visibility\": \"selected\",\n \"default\": false,\n \"selected_repositories_url\": \"https://api.github.com/orgs/octo-org/actions/runner_groups/2/repositories\",\n \"runners_url\": \"https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners\",\n \"inherited\": false,\n \"allows_public_repositories\": true,\n \"restricted_to_workflows\": true,\n \"selected_workflows\": [\n \"octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main\"\n ],\n \"workflow_restrictions_read_only\": false\n}"
|
||||
}
|
||||
]
|
||||
},
|
||||
@@ -5460,6 +5616,32 @@
|
||||
"rawType": "boolean",
|
||||
"rawDescription": "Whether the runner group can be used by `public` repositories.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
"restricted_to_workflows": {
|
||||
"description": "<p>If <code>true</code>, the runner group will be restricted to running only the workflows specified in the <code>selected_workflows</code> array.</p>",
|
||||
"type": "boolean",
|
||||
"default": false,
|
||||
"name": "restricted_to_workflows",
|
||||
"in": "body",
|
||||
"rawType": "boolean",
|
||||
"rawDescription": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
"selected_workflows": {
|
||||
"description": "<p>List of workflows the runner group should be allowed to run. This setting will be ignored unless <code>restricted_to_workflows</code> is set to <code>true</code>.</p>",
|
||||
"type": "array of strings",
|
||||
"items": {
|
||||
"type": "string",
|
||||
"description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.",
|
||||
"examples": [
|
||||
"octo-org/octo-repo/.github/workflows/deploy.yaml@main"
|
||||
]
|
||||
},
|
||||
"name": "selected_workflows",
|
||||
"in": "body",
|
||||
"rawType": "array",
|
||||
"rawDescription": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.",
|
||||
"childParamsGroups": []
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
@@ -5492,7 +5674,7 @@
|
||||
"httpStatusCode": "200",
|
||||
"httpStatusMessage": "OK",
|
||||
"description": "<p>Response</p>",
|
||||
"payload": "{\n \"id\": 2,\n \"name\": \"octo-runner-group\",\n \"visibility\": \"selected\",\n \"default\": false,\n \"selected_repositories_url\": \"https://api.github.com/orgs/octo-org/actions/runner-groups/2/repositories\",\n \"runners_url\": \"https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners\",\n \"inherited\": false,\n \"allows_public_repositories\": true\n}"
|
||||
"payload": "{\n \"id\": 2,\n \"name\": \"octo-runner-group\",\n \"visibility\": \"selected\",\n \"default\": false,\n \"selected_repositories_url\": \"https://api.github.com/orgs/octo-org/actions/runner-groups/2/repositories\",\n \"runners_url\": \"https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners\",\n \"inherited\": false,\n \"allows_public_repositories\": true,\n \"restricted_to_workflows\": true,\n \"selected_workflows\": [\n \"octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main\"\n ],\n \"workflow_restrictions_read_only\": false\n}"
|
||||
}
|
||||
],
|
||||
"bodyParameters": [
|
||||
@@ -5528,6 +5710,32 @@
|
||||
"rawType": "boolean",
|
||||
"rawDescription": "Whether the runner group can be used by `public` repositories.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"description": "<p>If <code>true</code>, the runner group will be restricted to running only the workflows specified in the <code>selected_workflows</code> array.</p>",
|
||||
"type": "boolean",
|
||||
"default": false,
|
||||
"name": "restricted_to_workflows",
|
||||
"in": "body",
|
||||
"rawType": "boolean",
|
||||
"rawDescription": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"description": "<p>List of workflows the runner group should be allowed to run. This setting will be ignored unless <code>restricted_to_workflows</code> is set to <code>true</code>.</p>",
|
||||
"type": "array of strings",
|
||||
"items": {
|
||||
"type": "string",
|
||||
"description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.",
|
||||
"examples": [
|
||||
"octo-org/octo-repo/.github/workflows/deploy.yaml@main"
|
||||
]
|
||||
},
|
||||
"name": "selected_workflows",
|
||||
"in": "body",
|
||||
"rawType": "array",
|
||||
"rawDescription": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.",
|
||||
"childParamsGroups": []
|
||||
}
|
||||
]
|
||||
},
|
||||
@@ -13403,11 +13611,6 @@
|
||||
"httpStatusCode": "404",
|
||||
"httpStatusMessage": "Not Found",
|
||||
"description": "<p>Resource not found</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "415",
|
||||
"httpStatusMessage": "Unsupported Media Type",
|
||||
"description": "<p>Preview header missing</p>"
|
||||
}
|
||||
],
|
||||
"subcategory": "apps"
|
||||
@@ -14388,11 +14591,6 @@
|
||||
"httpStatusMessage": "Not Found",
|
||||
"description": "<p>Resource not found</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "415",
|
||||
"httpStatusMessage": "Unsupported Media Type",
|
||||
"description": "<p>Preview header missing</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "422",
|
||||
"httpStatusMessage": "Unprocessable Entity",
|
||||
@@ -15400,11 +15598,6 @@
|
||||
"httpStatusCode": "404",
|
||||
"httpStatusMessage": "Not Found",
|
||||
"description": "<p>Resource not found</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "415",
|
||||
"httpStatusMessage": "Unsupported Media Type",
|
||||
"description": "<p>Preview header missing</p>"
|
||||
}
|
||||
],
|
||||
"subcategory": "apps"
|
||||
@@ -15738,11 +15931,6 @@
|
||||
"httpStatusCode": "403",
|
||||
"httpStatusMessage": "Forbidden",
|
||||
"description": "<p>Forbidden</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "415",
|
||||
"httpStatusMessage": "Unsupported Media Type",
|
||||
"description": "<p>Preview header missing</p>"
|
||||
}
|
||||
]
|
||||
},
|
||||
@@ -19686,11 +19874,6 @@
|
||||
"httpStatusCode": "404",
|
||||
"httpStatusMessage": "Not Found",
|
||||
"description": "<p>Resource not found</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "415",
|
||||
"httpStatusMessage": "Unsupported Media Type",
|
||||
"description": "<p>Preview header missing</p>"
|
||||
}
|
||||
],
|
||||
"subcategory": "branches"
|
||||
@@ -20397,6 +20580,15 @@
|
||||
"rawDescription": "Allows deletion of the protected branch by anyone with write access to the repository. Set to `false` to prevent deletion of the protected branch. Default: `false`. For more information, see \"[Enabling force pushes to a protected branch](https://docs.github.com/en/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)\" in the GitHub Help documentation.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
"block_creations": {
|
||||
"type": "boolean",
|
||||
"description": "<p>Blocks creation of new branches which match the branch protection pattern. Set to <code>true</code> to prohibit new branch creation. Default: <code>false</code>.</p>",
|
||||
"name": "block_creations",
|
||||
"in": "body",
|
||||
"rawType": "boolean",
|
||||
"rawDescription": "Blocks creation of new branches which match the branch protection pattern. Set to `true` to prohibit new branch creation. Default: `false`.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
"required_conversation_resolution": {
|
||||
"type": "boolean",
|
||||
"description": "<p>Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to <code>false</code> to disable. Default: <code>false</code>.</p>",
|
||||
@@ -20457,6 +20649,7 @@
|
||||
"required_linear_history": true,
|
||||
"allow_force_pushes": true,
|
||||
"allow_deletions": true,
|
||||
"block_creations": true,
|
||||
"required_conversation_resolution": true
|
||||
}
|
||||
}
|
||||
@@ -20692,6 +20885,15 @@
|
||||
"rawDescription": "Allows deletion of the protected branch by anyone with write access to the repository. Set to `false` to prevent deletion of the protected branch. Default: `false`. For more information, see \"[Enabling force pushes to a protected branch](https://docs.github.com/en/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)\" in the GitHub Help documentation.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"type": "boolean",
|
||||
"description": "<p>Blocks creation of new branches which match the branch protection pattern. Set to <code>true</code> to prohibit new branch creation. Default: <code>false</code>.</p>",
|
||||
"name": "block_creations",
|
||||
"in": "body",
|
||||
"rawType": "boolean",
|
||||
"rawDescription": "Blocks creation of new branches which match the branch protection pattern. Set to `true` to prohibit new branch creation. Default: `false`.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"type": "boolean",
|
||||
"description": "<p>Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to <code>false</code> to disable. Default: <code>false</code>.</p>",
|
||||
@@ -34214,7 +34416,7 @@
|
||||
"category": "commits",
|
||||
"notes": [],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, additionally returns open pull requests associated with the commit. The results may include open and closed pull requests. Additional preview headers may be required to see certain details for associated pull requests, such as whether a pull request is in a draft state. For more information about previews that might affect this endpoint, see the <a href=\"https://docs.github.com/rest/reference/pulls#list-pull-requests\">List pull requests</a> endpoint.</p>",
|
||||
"descriptionHTML": "<p>Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, additionally returns open pull requests associated with the commit. The results may include open and closed pull requests.</p>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
@@ -36446,6 +36648,93 @@
|
||||
}
|
||||
]
|
||||
},
|
||||
"dependency-graph": {
|
||||
"dependency-review": [
|
||||
{
|
||||
"verb": "get",
|
||||
"requestPath": "/repos/{owner}/{repo}/dependency-graph/compare/{basehead}",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "owner",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "repo",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "basehead",
|
||||
"description": "The base and head Git revisions to compare. The Git revisions will be resolved to commit SHAs. Named revisions will be resolved to their corresponding HEAD commits, and an appropriate merge base will be determined. This parameter expects the format `{base}...{head}`.",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": "<p>The base and head Git revisions to compare. The Git revisions will be resolved to commit SHAs. Named revisions will be resolved to their corresponding HEAD commits, and an appropriate merge base will be determined. This parameter expects the format <code>{base}...{head}</code>.</p>"
|
||||
},
|
||||
{
|
||||
"name": "name",
|
||||
"description": "The full path, relative to the repository root, of the dependency manifest file.",
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": "<p>The full path, relative to the repository root, of the dependency manifest file.</p>"
|
||||
}
|
||||
],
|
||||
"x-codeSamples": [
|
||||
{
|
||||
"lang": "Shell",
|
||||
"source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/dependency-graph/compare/BASEHEAD"
|
||||
},
|
||||
{
|
||||
"lang": "JavaScript",
|
||||
"source": "await octokit.request('GET /repos/{owner}/{repo}/dependency-graph/compare/{basehead}', {\n owner: 'octocat',\n repo: 'hello-world',\n basehead: 'basehead'\n})"
|
||||
}
|
||||
],
|
||||
"summary": "Get a diff of the dependencies between commits",
|
||||
"x-github": {
|
||||
"category": "dependency-graph",
|
||||
"subcategory": "dependency-review"
|
||||
},
|
||||
"slug": "get-a-diff-of-the-dependencies-between-commits",
|
||||
"category": "dependency-graph",
|
||||
"subcategory": "dependency-review",
|
||||
"notes": [],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Gets the diff of the dependency changes between two commits of a repository, based on the changes to the dependency manifests made in those commits.</p>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"httpStatusMessage": "OK",
|
||||
"description": "<p>Response</p>",
|
||||
"payload": "[\n {\n \"change_type\": \"removed\",\n \"manifest\": \"package.json\",\n \"ecosystem\": \"npm\",\n \"name\": \"helmet\",\n \"version\": \"4.6.0\",\n \"package_url\": \"pkg:npm/helmet@4.6.0\",\n \"license\": \"MIT\",\n \"source_repository_url\": \"https://github.com/helmetjs/helmet\",\n \"vulnerabilities\": []\n },\n {\n \"change_type\": \"added\",\n \"manifest\": \"package.json\",\n \"ecosystem\": \"npm\",\n \"name\": \"helmet\",\n \"version\": \"5.0.0\",\n \"package_url\": \"pkg:npm/helmet@5.0.0\",\n \"license\": \"MIT\",\n \"source_repository_url\": \"https://github.com/helmetjs/helmet\",\n \"vulnerabilities\": []\n },\n {\n \"change_type\": \"added\",\n \"manifest\": \"Gemfile\",\n \"ecosystem\": \"rubygems\",\n \"name\": \"ruby-openid\",\n \"version\": \"2.7.0\",\n \"package_url\": \"pkg:gem/ruby-openid@2.7.0\",\n \"license\": null,\n \"source_repository_url\": \"https://github.com/openid/ruby-openid\",\n \"vulnerabilities\": [\n {\n \"severity\": \"critical\",\n \"advisory_ghsa_id\": \"GHSA-fqfj-cmh6-hj49\",\n \"advisory_summary\": \"Ruby OpenID\",\n \"advisory_url\": \"https://github.com/advisories/GHSA-fqfj-cmh6-hj49\"\n }\n ]\n }\n]"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "403",
|
||||
"httpStatusMessage": "Forbidden",
|
||||
"description": "<p>Forbidden</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "404",
|
||||
"httpStatusMessage": "Not Found",
|
||||
"description": "<p>Resource not found</p>"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
"deploy_keys": {
|
||||
"deploy_keys": [
|
||||
{
|
||||
@@ -43121,7 +43410,7 @@
|
||||
"category": "git",
|
||||
"subcategory": "commits",
|
||||
"notes": [],
|
||||
"descriptionHTML": "<p>Creates a new Git <a href=\"https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects\">commit object</a>.</p>\n<p><strong>Signature verification object</strong></p>\n<p>The response will include a <code>verification</code> object that describes the result of verifying the commit's signature. The following fields are included in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>verified</code></td><td><code>boolean</code></td><td>Indicates whether GitHub considers the signature in this commit to be verified.</td></tr><tr><td><code>reason</code></td><td><code>string</code></td><td>The reason for verified value. Possible values and their meanings are enumerated in table below.</td></tr><tr><td><code>signature</code></td><td><code>string</code></td><td>The signature that was extracted from the commit.</td></tr><tr><td><code>payload</code></td><td><code>string</code></td><td>The value that was signed.</td></tr></tbody></table>\n<p>These are the possible values for <code>reason</code> in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td><code>expired_key</code></td><td>The key that made the signature is expired.</td></tr><tr><td><code>not_signing_key</code></td><td>The \"signing\" flag is not among the usage flags in the GPG key that made the signature.</td></tr><tr><td><code>gpgverify_error</code></td><td>There was an error communicating with the signature verification service.</td></tr><tr><td><code>gpgverify_unavailable</code></td><td>The signature verification service is currently unavailable.</td></tr><tr><td><code>unsigned</code></td><td>The object does not include a signature.</td></tr><tr><td><code>unknown_signature_type</code></td><td>A non-PGP signature was found in the commit.</td></tr><tr><td><code>no_user</code></td><td>No user was associated with the <code>committer</code> email address in the commit.</td></tr><tr><td><code>unverified_email</code></td><td>The <code>committer</code> email address in the commit was associated with a user, but the email address is not verified on her/his account.</td></tr><tr><td><code>bad_email</code></td><td>The <code>committer</code> email address in the commit is not included in the identities of the PGP key that made the signature.</td></tr><tr><td><code>unknown_key</code></td><td>The key that made the signature has not been registered with any user's account.</td></tr><tr><td><code>malformed_signature</code></td><td>There was an error parsing the signature.</td></tr><tr><td><code>invalid</code></td><td>The signature could not be cryptographically verified using the key whose key-id was found in the signature.</td></tr><tr><td><code>valid</code></td><td>None of the above errors applied, so the signature is considered to be verified.</td></tr></tbody></table>",
|
||||
"descriptionHTML": "<p>Creates a new Git <a href=\"https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects\">commit object</a>.</p>\n<p><strong>Signature verification object</strong></p>\n<p>The response will include a <code>verification</code> object that describes the result of verifying the commit's signature. The following fields are included in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>verified</code></td><td><code>boolean</code></td><td>Indicates whether GitHub considers the signature in this commit to be verified.</td></tr><tr><td><code>reason</code></td><td><code>string</code></td><td>The reason for verified value. Possible values and their meanings are enumerated in the table below.</td></tr><tr><td><code>signature</code></td><td><code>string</code></td><td>The signature that was extracted from the commit.</td></tr><tr><td><code>payload</code></td><td><code>string</code></td><td>The value that was signed.</td></tr></tbody></table>\n<p>These are the possible values for <code>reason</code> in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td><code>expired_key</code></td><td>The key that made the signature is expired.</td></tr><tr><td><code>not_signing_key</code></td><td>The \"signing\" flag is not among the usage flags in the GPG key that made the signature.</td></tr><tr><td><code>gpgverify_error</code></td><td>There was an error communicating with the signature verification service.</td></tr><tr><td><code>gpgverify_unavailable</code></td><td>The signature verification service is currently unavailable.</td></tr><tr><td><code>unsigned</code></td><td>The object does not include a signature.</td></tr><tr><td><code>unknown_signature_type</code></td><td>A non-PGP signature was found in the commit.</td></tr><tr><td><code>no_user</code></td><td>No user was associated with the <code>committer</code> email address in the commit.</td></tr><tr><td><code>unverified_email</code></td><td>The <code>committer</code> email address in the commit was associated with a user, but the email address is not verified on her/his account.</td></tr><tr><td><code>bad_email</code></td><td>The <code>committer</code> email address in the commit is not included in the identities of the PGP key that made the signature.</td></tr><tr><td><code>unknown_key</code></td><td>The key that made the signature has not been registered with any user's account.</td></tr><tr><td><code>malformed_signature</code></td><td>There was an error parsing the signature.</td></tr><tr><td><code>invalid</code></td><td>The signature could not be cryptographically verified using the key whose key-id was found in the signature.</td></tr><tr><td><code>valid</code></td><td>None of the above errors applied, so the signature is considered to be verified.</td></tr></tbody></table>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "201",
|
||||
@@ -43391,7 +43680,7 @@
|
||||
"subcategory": "commits",
|
||||
"notes": [],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Gets a Git <a href=\"https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects\">commit object</a>.</p>\n<p><strong>Signature verification object</strong></p>\n<p>The response will include a <code>verification</code> object that describes the result of verifying the commit's signature. The following fields are included in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>verified</code></td><td><code>boolean</code></td><td>Indicates whether GitHub considers the signature in this commit to be verified.</td></tr><tr><td><code>reason</code></td><td><code>string</code></td><td>The reason for verified value. Possible values and their meanings are enumerated in table below.</td></tr><tr><td><code>signature</code></td><td><code>string</code></td><td>The signature that was extracted from the commit.</td></tr><tr><td><code>payload</code></td><td><code>string</code></td><td>The value that was signed.</td></tr></tbody></table>\n<p>These are the possible values for <code>reason</code> in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td><code>expired_key</code></td><td>The key that made the signature is expired.</td></tr><tr><td><code>not_signing_key</code></td><td>The \"signing\" flag is not among the usage flags in the GPG key that made the signature.</td></tr><tr><td><code>gpgverify_error</code></td><td>There was an error communicating with the signature verification service.</td></tr><tr><td><code>gpgverify_unavailable</code></td><td>The signature verification service is currently unavailable.</td></tr><tr><td><code>unsigned</code></td><td>The object does not include a signature.</td></tr><tr><td><code>unknown_signature_type</code></td><td>A non-PGP signature was found in the commit.</td></tr><tr><td><code>no_user</code></td><td>No user was associated with the <code>committer</code> email address in the commit.</td></tr><tr><td><code>unverified_email</code></td><td>The <code>committer</code> email address in the commit was associated with a user, but the email address is not verified on her/his account.</td></tr><tr><td><code>bad_email</code></td><td>The <code>committer</code> email address in the commit is not included in the identities of the PGP key that made the signature.</td></tr><tr><td><code>unknown_key</code></td><td>The key that made the signature has not been registered with any user's account.</td></tr><tr><td><code>malformed_signature</code></td><td>There was an error parsing the signature.</td></tr><tr><td><code>invalid</code></td><td>The signature could not be cryptographically verified using the key whose key-id was found in the signature.</td></tr><tr><td><code>valid</code></td><td>None of the above errors applied, so the signature is considered to be verified.</td></tr></tbody></table>",
|
||||
"descriptionHTML": "<p>Gets a Git <a href=\"https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects\">commit object</a>.</p>\n<p><strong>Signature verification object</strong></p>\n<p>The response will include a <code>verification</code> object that describes the result of verifying the commit's signature. The following fields are included in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>verified</code></td><td><code>boolean</code></td><td>Indicates whether GitHub considers the signature in this commit to be verified.</td></tr><tr><td><code>reason</code></td><td><code>string</code></td><td>The reason for verified value. Possible values and their meanings are enumerated in the table below.</td></tr><tr><td><code>signature</code></td><td><code>string</code></td><td>The signature that was extracted from the commit.</td></tr><tr><td><code>payload</code></td><td><code>string</code></td><td>The value that was signed.</td></tr></tbody></table>\n<p>These are the possible values for <code>reason</code> in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td><code>expired_key</code></td><td>The key that made the signature is expired.</td></tr><tr><td><code>not_signing_key</code></td><td>The \"signing\" flag is not among the usage flags in the GPG key that made the signature.</td></tr><tr><td><code>gpgverify_error</code></td><td>There was an error communicating with the signature verification service.</td></tr><tr><td><code>gpgverify_unavailable</code></td><td>The signature verification service is currently unavailable.</td></tr><tr><td><code>unsigned</code></td><td>The object does not include a signature.</td></tr><tr><td><code>unknown_signature_type</code></td><td>A non-PGP signature was found in the commit.</td></tr><tr><td><code>no_user</code></td><td>No user was associated with the <code>committer</code> email address in the commit.</td></tr><tr><td><code>unverified_email</code></td><td>The <code>committer</code> email address in the commit was associated with a user, but the email address is not verified on her/his account.</td></tr><tr><td><code>bad_email</code></td><td>The <code>committer</code> email address in the commit is not included in the identities of the PGP key that made the signature.</td></tr><tr><td><code>unknown_key</code></td><td>The key that made the signature has not been registered with any user's account.</td></tr><tr><td><code>malformed_signature</code></td><td>There was an error parsing the signature.</td></tr><tr><td><code>invalid</code></td><td>The signature could not be cryptographically verified using the key whose key-id was found in the signature.</td></tr><tr><td><code>valid</code></td><td>None of the above errors applied, so the signature is considered to be verified.</td></tr></tbody></table>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
@@ -56100,11 +56389,6 @@
|
||||
"httpStatusMessage": "OK",
|
||||
"description": "<p>Response</p>",
|
||||
"payload": "[\n {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n]"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "415",
|
||||
"httpStatusMessage": "Unsupported Media Type",
|
||||
"description": "<p>Preview header missing</p>"
|
||||
}
|
||||
]
|
||||
},
|
||||
@@ -63534,11 +63818,6 @@
|
||||
"httpStatusMessage": "Forbidden",
|
||||
"description": "<p>Forbidden</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "415",
|
||||
"httpStatusMessage": "Unsupported Media Type",
|
||||
"description": "<p>Preview header missing</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "422",
|
||||
"httpStatusMessage": "Unprocessable Entity",
|
||||
@@ -67034,16 +67313,16 @@
|
||||
},
|
||||
"position": {
|
||||
"type": "integer",
|
||||
"description": "<p><strong>Required without <code>comfort-fade</code> preview unless using <code>in_reply_to</code></strong>. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.</p>",
|
||||
"description": "<p>The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.</p>",
|
||||
"name": "position",
|
||||
"in": "body",
|
||||
"rawType": "integer",
|
||||
"rawDescription": "**Required without `comfort-fade` preview unless using `in_reply_to`**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.",
|
||||
"rawDescription": "The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
"side": {
|
||||
"type": "string",
|
||||
"description": "<p><strong>Required with <code>comfort-fade</code> preview unless using <code>in_reply_to</code></strong>. In a split diff view, the side of the diff that the pull request's changes appear on. Can be <code>LEFT</code> or <code>RIGHT</code>. Use <code>LEFT</code> for deletions that appear in red. Use <code>RIGHT</code> for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"<a href=\"https://docs.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options\">Diff view options</a>\" in the GitHub Help documentation.</p>",
|
||||
"description": "<p>In a split diff view, the side of the diff that the pull request's changes appear on. Can be <code>LEFT</code> or <code>RIGHT</code>. Use <code>LEFT</code> for deletions that appear in red. Use <code>RIGHT</code> for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"<a href=\"https://docs.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options\">Diff view options</a>\" in the GitHub Help documentation.</p>",
|
||||
"enum": [
|
||||
"LEFT",
|
||||
"RIGHT"
|
||||
@@ -67051,30 +67330,30 @@
|
||||
"name": "side",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
"rawDescription": "**Required with `comfort-fade` preview unless using `in_reply_to`**. In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"[Diff view options](https://docs.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation.",
|
||||
"rawDescription": "In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"[Diff view options](https://docs.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
"line": {
|
||||
"type": "integer",
|
||||
"description": "<p><strong>Required with <code>comfort-fade</code> preview unless using <code>in_reply_to</code></strong>. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.</p>",
|
||||
"description": "<p>The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.</p>",
|
||||
"name": "line",
|
||||
"in": "body",
|
||||
"rawType": "integer",
|
||||
"rawDescription": "**Required with `comfort-fade` preview unless using `in_reply_to`**. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.",
|
||||
"rawDescription": "The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
"start_line": {
|
||||
"type": "integer",
|
||||
"description": "<p><strong>Required when using multi-line comments unless using <code>in_reply_to</code></strong>. To create multi-line comments, you must use the <code>comfort-fade</code> preview header. The <code>start_line</code> is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"<a href=\"https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request\">Commenting on a pull request</a>\" in the GitHub Help documentation.</p>",
|
||||
"description": "<p><strong>Required when using multi-line comments unless using <code>in_reply_to</code></strong>. The <code>start_line</code> is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"<a href=\"https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request\">Commenting on a pull request</a>\" in the GitHub Help documentation.</p>",
|
||||
"name": "start_line",
|
||||
"in": "body",
|
||||
"rawType": "integer",
|
||||
"rawDescription": "**Required when using multi-line comments unless using `in_reply_to`**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation.",
|
||||
"rawDescription": "**Required when using multi-line comments unless using `in_reply_to`**. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
"start_side": {
|
||||
"type": "string",
|
||||
"description": "<p><strong>Required when using multi-line comments unless using <code>in_reply_to</code></strong>. To create multi-line comments, you must use the <code>comfort-fade</code> preview header. The <code>start_side</code> is the starting side of the diff that the comment applies to. Can be <code>LEFT</code> or <code>RIGHT</code>. To learn more about multi-line comments, see \"<a href=\"https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request\">Commenting on a pull request</a>\" in the GitHub Help documentation. See <code>side</code> in this table for additional context.</p>",
|
||||
"description": "<p><strong>Required when using multi-line comments unless using <code>in_reply_to</code></strong>. The <code>start_side</code> is the starting side of the diff that the comment applies to. Can be <code>LEFT</code> or <code>RIGHT</code>. To learn more about multi-line comments, see \"<a href=\"https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request\">Commenting on a pull request</a>\" in the GitHub Help documentation. See <code>side</code> in this table for additional context.</p>",
|
||||
"enum": [
|
||||
"LEFT",
|
||||
"RIGHT",
|
||||
@@ -67083,7 +67362,7 @@
|
||||
"name": "start_side",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
"rawDescription": "**Required when using multi-line comments unless using `in_reply_to`**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.",
|
||||
"rawDescription": "**Required when using multi-line comments unless using `in_reply_to`**. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
"in_reply_to": {
|
||||
@@ -67179,16 +67458,16 @@
|
||||
},
|
||||
{
|
||||
"type": "integer",
|
||||
"description": "<p><strong>Required without <code>comfort-fade</code> preview unless using <code>in_reply_to</code></strong>. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.</p>",
|
||||
"description": "<p>The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.</p>",
|
||||
"name": "position",
|
||||
"in": "body",
|
||||
"rawType": "integer",
|
||||
"rawDescription": "**Required without `comfort-fade` preview unless using `in_reply_to`**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.",
|
||||
"rawDescription": "The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"description": "<p><strong>Required with <code>comfort-fade</code> preview unless using <code>in_reply_to</code></strong>. In a split diff view, the side of the diff that the pull request's changes appear on. Can be <code>LEFT</code> or <code>RIGHT</code>. Use <code>LEFT</code> for deletions that appear in red. Use <code>RIGHT</code> for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"<a href=\"https://docs.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options\">Diff view options</a>\" in the GitHub Help documentation.</p>",
|
||||
"description": "<p>In a split diff view, the side of the diff that the pull request's changes appear on. Can be <code>LEFT</code> or <code>RIGHT</code>. Use <code>LEFT</code> for deletions that appear in red. Use <code>RIGHT</code> for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"<a href=\"https://docs.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options\">Diff view options</a>\" in the GitHub Help documentation.</p>",
|
||||
"enum": [
|
||||
"LEFT",
|
||||
"RIGHT"
|
||||
@@ -67196,30 +67475,30 @@
|
||||
"name": "side",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
"rawDescription": "**Required with `comfort-fade` preview unless using `in_reply_to`**. In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"[Diff view options](https://docs.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation.",
|
||||
"rawDescription": "In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"[Diff view options](https://docs.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"type": "integer",
|
||||
"description": "<p><strong>Required with <code>comfort-fade</code> preview unless using <code>in_reply_to</code></strong>. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.</p>",
|
||||
"description": "<p>The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.</p>",
|
||||
"name": "line",
|
||||
"in": "body",
|
||||
"rawType": "integer",
|
||||
"rawDescription": "**Required with `comfort-fade` preview unless using `in_reply_to`**. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.",
|
||||
"rawDescription": "The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"type": "integer",
|
||||
"description": "<p><strong>Required when using multi-line comments unless using <code>in_reply_to</code></strong>. To create multi-line comments, you must use the <code>comfort-fade</code> preview header. The <code>start_line</code> is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"<a href=\"https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request\">Commenting on a pull request</a>\" in the GitHub Help documentation.</p>",
|
||||
"description": "<p><strong>Required when using multi-line comments unless using <code>in_reply_to</code></strong>. The <code>start_line</code> is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"<a href=\"https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request\">Commenting on a pull request</a>\" in the GitHub Help documentation.</p>",
|
||||
"name": "start_line",
|
||||
"in": "body",
|
||||
"rawType": "integer",
|
||||
"rawDescription": "**Required when using multi-line comments unless using `in_reply_to`**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation.",
|
||||
"rawDescription": "**Required when using multi-line comments unless using `in_reply_to`**. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"description": "<p><strong>Required when using multi-line comments unless using <code>in_reply_to</code></strong>. To create multi-line comments, you must use the <code>comfort-fade</code> preview header. The <code>start_side</code> is the starting side of the diff that the comment applies to. Can be <code>LEFT</code> or <code>RIGHT</code>. To learn more about multi-line comments, see \"<a href=\"https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request\">Commenting on a pull request</a>\" in the GitHub Help documentation. See <code>side</code> in this table for additional context.</p>",
|
||||
"description": "<p><strong>Required when using multi-line comments unless using <code>in_reply_to</code></strong>. The <code>start_side</code> is the starting side of the diff that the comment applies to. Can be <code>LEFT</code> or <code>RIGHT</code>. To learn more about multi-line comments, see \"<a href=\"https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request\">Commenting on a pull request</a>\" in the GitHub Help documentation. See <code>side</code> in this table for additional context.</p>",
|
||||
"enum": [
|
||||
"LEFT",
|
||||
"RIGHT",
|
||||
@@ -67228,7 +67507,7 @@
|
||||
"name": "start_side",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
"rawDescription": "**Required when using multi-line comments unless using `in_reply_to`**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.",
|
||||
"rawDescription": "**Required when using multi-line comments unless using `in_reply_to`**. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
@@ -69913,11 +70192,6 @@
|
||||
"description": "<p>Reaction created</p>",
|
||||
"payload": "{\n \"id\": 1,\n \"node_id\": \"MDg6UmVhY3Rpb24x\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"content\": \"heart\",\n \"created_at\": \"2016-05-20T20:09:31Z\"\n}"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "415",
|
||||
"httpStatusMessage": "Unsupported Media Type",
|
||||
"description": "<p>Preview header missing</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "422",
|
||||
"httpStatusMessage": "Unprocessable Entity",
|
||||
@@ -71078,11 +71352,6 @@
|
||||
"httpStatusCode": "404",
|
||||
"httpStatusMessage": "Not Found",
|
||||
"description": "<p>Resource not found</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "415",
|
||||
"httpStatusMessage": "Unsupported Media Type",
|
||||
"description": "<p>Preview header missing</p>"
|
||||
}
|
||||
],
|
||||
"subcategory": "reactions"
|
||||
@@ -72772,11 +73041,6 @@
|
||||
"httpStatusCode": "404",
|
||||
"httpStatusMessage": "Not Found",
|
||||
"description": "<p>Resource not found</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "415",
|
||||
"httpStatusMessage": "Unsupported Media Type",
|
||||
"description": "<p>Preview header missing</p>"
|
||||
}
|
||||
]
|
||||
},
|
||||
@@ -73924,7 +74188,7 @@
|
||||
},
|
||||
"secret_scanning_push_protection": {
|
||||
"type": "object",
|
||||
"description": "Use the `status` property to enable or disable secret scanning push protection for this repository. For more information, see \"[About push protection](/enterprise-cloud@latest/early-access/code-security/secret-scanning/protecting-pushes-with-secret-scanning).\"",
|
||||
"description": "Use the `status` property to enable or disable secret scanning push protection for this repository. For more information, see \"[Protecting pushes with secret scanning](/enterprise-cloud@latest/code-security/secret-scanning/protecting-pushes-with-secret-scanning).\"",
|
||||
"properties": {
|
||||
"status": {
|
||||
"type": "string",
|
||||
@@ -74190,7 +74454,7 @@
|
||||
},
|
||||
"secret_scanning_push_protection": {
|
||||
"type": "object",
|
||||
"description": "Use the `status` property to enable or disable secret scanning push protection for this repository. For more information, see \"[About push protection](/enterprise-cloud@latest/early-access/code-security/secret-scanning/protecting-pushes-with-secret-scanning).\"",
|
||||
"description": "Use the `status` property to enable or disable secret scanning push protection for this repository. For more information, see \"[Protecting pushes with secret scanning](/enterprise-cloud@latest/code-security/secret-scanning/protecting-pushes-with-secret-scanning).\"",
|
||||
"properties": {
|
||||
"status": {
|
||||
"type": "string",
|
||||
@@ -83712,11 +83976,6 @@
|
||||
"httpStatusMessage": "Not Found",
|
||||
"description": "<p>Resource not found</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "415",
|
||||
"httpStatusMessage": "Unsupported Media Type",
|
||||
"description": "<p>Preview header missing</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "422",
|
||||
"httpStatusMessage": "Unprocessable Entity",
|
||||
@@ -88774,11 +89033,6 @@
|
||||
"httpStatusCode": "404",
|
||||
"httpStatusMessage": "Not Found",
|
||||
"description": "<p>Resource not found</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "415",
|
||||
"httpStatusMessage": "Unsupported Media Type",
|
||||
"description": "<p>Preview header missing</p>"
|
||||
}
|
||||
]
|
||||
},
|
||||
|
||||
@@ -10200,11 +10200,6 @@
|
||||
"httpStatusCode": "404",
|
||||
"httpStatusMessage": "Not Found",
|
||||
"description": "<p>Resource not found</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "415",
|
||||
"httpStatusMessage": "Unsupported Media Type",
|
||||
"description": "<p>Preview header missing</p>"
|
||||
}
|
||||
],
|
||||
"subcategory": "apps"
|
||||
@@ -11211,11 +11206,6 @@
|
||||
"httpStatusMessage": "Not Found",
|
||||
"description": "<p>Resource not found</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "415",
|
||||
"httpStatusMessage": "Unsupported Media Type",
|
||||
"description": "<p>Preview header missing</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "422",
|
||||
"httpStatusMessage": "Unprocessable Entity",
|
||||
@@ -12249,11 +12239,6 @@
|
||||
"httpStatusCode": "404",
|
||||
"httpStatusMessage": "Not Found",
|
||||
"description": "<p>Resource not found</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "415",
|
||||
"httpStatusMessage": "Unsupported Media Type",
|
||||
"description": "<p>Preview header missing</p>"
|
||||
}
|
||||
],
|
||||
"subcategory": "apps"
|
||||
@@ -12764,11 +12749,6 @@
|
||||
"httpStatusCode": "403",
|
||||
"httpStatusMessage": "Forbidden",
|
||||
"description": "<p>Forbidden</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "415",
|
||||
"httpStatusMessage": "Unsupported Media Type",
|
||||
"description": "<p>Preview header missing</p>"
|
||||
}
|
||||
]
|
||||
},
|
||||
@@ -15918,11 +15898,6 @@
|
||||
"httpStatusCode": "404",
|
||||
"httpStatusMessage": "Not Found",
|
||||
"description": "<p>Resource not found</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "415",
|
||||
"httpStatusMessage": "Unsupported Media Type",
|
||||
"description": "<p>Preview header missing</p>"
|
||||
}
|
||||
],
|
||||
"subcategory": "branches"
|
||||
@@ -16510,6 +16485,15 @@
|
||||
"rawDescription": "Allows deletion of the protected branch by anyone with write access to the repository. Set to `false` to prevent deletion of the protected branch. Default: `false`. For more information, see \"[Enabling force pushes to a protected branch](https://docs.github.com/en/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)\" in the GitHub Help documentation.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
"block_creations": {
|
||||
"type": "boolean",
|
||||
"description": "<p>Blocks creation of new branches which match the branch protection pattern. Set to <code>true</code> to prohibit new branch creation. Default: <code>false</code>.</p>",
|
||||
"name": "block_creations",
|
||||
"in": "body",
|
||||
"rawType": "boolean",
|
||||
"rawDescription": "Blocks creation of new branches which match the branch protection pattern. Set to `true` to prohibit new branch creation. Default: `false`.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
"required_conversation_resolution": {
|
||||
"type": "boolean",
|
||||
"description": "<p>Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to <code>false</code> to disable. Default: <code>false</code>.</p>",
|
||||
@@ -16582,6 +16566,7 @@
|
||||
"required_linear_history": true,
|
||||
"allow_force_pushes": true,
|
||||
"allow_deletions": true,
|
||||
"block_creations": true,
|
||||
"required_conversation_resolution": true
|
||||
}
|
||||
}
|
||||
@@ -16803,6 +16788,15 @@
|
||||
"rawDescription": "Allows deletion of the protected branch by anyone with write access to the repository. Set to `false` to prevent deletion of the protected branch. Default: `false`. For more information, see \"[Enabling force pushes to a protected branch](https://docs.github.com/en/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)\" in the GitHub Help documentation.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"type": "boolean",
|
||||
"description": "<p>Blocks creation of new branches which match the branch protection pattern. Set to <code>true</code> to prohibit new branch creation. Default: <code>false</code>.</p>",
|
||||
"name": "block_creations",
|
||||
"in": "body",
|
||||
"rawType": "boolean",
|
||||
"rawDescription": "Blocks creation of new branches which match the branch protection pattern. Set to `true` to prohibit new branch creation. Default: `false`.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"type": "boolean",
|
||||
"description": "<p>Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to <code>false</code> to disable. Default: <code>false</code>.</p>",
|
||||
@@ -30602,17 +30596,6 @@
|
||||
"verb": "get",
|
||||
"requestPath": "/admin/hooks",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "accept",
|
||||
"description": "This API is under preview and subject to change.",
|
||||
"in": "header",
|
||||
"schema": {
|
||||
"type": "string",
|
||||
"default": "application/vnd.github.superpro-preview+json"
|
||||
},
|
||||
"required": true,
|
||||
"descriptionHTML": "<p>This API is under preview and subject to change.</p>"
|
||||
},
|
||||
{
|
||||
"name": "per_page",
|
||||
"description": "Results per page (max 100)",
|
||||
@@ -31391,17 +31374,6 @@
|
||||
"verb": "delete",
|
||||
"requestPath": "/admin/hooks/{hook_id}",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "accept",
|
||||
"description": "This API is under preview and subject to change.",
|
||||
"in": "header",
|
||||
"schema": {
|
||||
"type": "string",
|
||||
"default": "application/vnd.github.superpro-preview+json"
|
||||
},
|
||||
"required": true,
|
||||
"descriptionHTML": "<p>This API is under preview and subject to change.</p>"
|
||||
},
|
||||
{
|
||||
"name": "hook_id",
|
||||
"in": "path",
|
||||
@@ -31452,17 +31424,6 @@
|
||||
"verb": "post",
|
||||
"requestPath": "/admin/hooks/{hook_id}/pings",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "accept",
|
||||
"description": "This API is under preview and subject to change.",
|
||||
"in": "header",
|
||||
"schema": {
|
||||
"type": "string",
|
||||
"default": "application/vnd.github.superpro-preview+json"
|
||||
},
|
||||
"required": true,
|
||||
"descriptionHTML": "<p>This API is under preview and subject to change.</p>"
|
||||
},
|
||||
{
|
||||
"name": "hook_id",
|
||||
"in": "path",
|
||||
@@ -37547,7 +37508,7 @@
|
||||
"category": "git",
|
||||
"subcategory": "commits",
|
||||
"notes": [],
|
||||
"descriptionHTML": "<p>Creates a new Git <a href=\"https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects\">commit object</a>.</p>\n<p><strong>Signature verification object</strong></p>\n<p>The response will include a <code>verification</code> object that describes the result of verifying the commit's signature. The following fields are included in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>verified</code></td><td><code>boolean</code></td><td>Indicates whether GitHub considers the signature in this commit to be verified.</td></tr><tr><td><code>reason</code></td><td><code>string</code></td><td>The reason for verified value. Possible values and their meanings are enumerated in table below.</td></tr><tr><td><code>signature</code></td><td><code>string</code></td><td>The signature that was extracted from the commit.</td></tr><tr><td><code>payload</code></td><td><code>string</code></td><td>The value that was signed.</td></tr></tbody></table>\n<p>These are the possible values for <code>reason</code> in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td><code>expired_key</code></td><td>The key that made the signature is expired.</td></tr><tr><td><code>not_signing_key</code></td><td>The \"signing\" flag is not among the usage flags in the GPG key that made the signature.</td></tr><tr><td><code>gpgverify_error</code></td><td>There was an error communicating with the signature verification service.</td></tr><tr><td><code>gpgverify_unavailable</code></td><td>The signature verification service is currently unavailable.</td></tr><tr><td><code>unsigned</code></td><td>The object does not include a signature.</td></tr><tr><td><code>unknown_signature_type</code></td><td>A non-PGP signature was found in the commit.</td></tr><tr><td><code>no_user</code></td><td>No user was associated with the <code>committer</code> email address in the commit.</td></tr><tr><td><code>unverified_email</code></td><td>The <code>committer</code> email address in the commit was associated with a user, but the email address is not verified on her/his account.</td></tr><tr><td><code>bad_email</code></td><td>The <code>committer</code> email address in the commit is not included in the identities of the PGP key that made the signature.</td></tr><tr><td><code>unknown_key</code></td><td>The key that made the signature has not been registered with any user's account.</td></tr><tr><td><code>malformed_signature</code></td><td>There was an error parsing the signature.</td></tr><tr><td><code>invalid</code></td><td>The signature could not be cryptographically verified using the key whose key-id was found in the signature.</td></tr><tr><td><code>valid</code></td><td>None of the above errors applied, so the signature is considered to be verified.</td></tr></tbody></table>",
|
||||
"descriptionHTML": "<p>Creates a new Git <a href=\"https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects\">commit object</a>.</p>\n<p><strong>Signature verification object</strong></p>\n<p>The response will include a <code>verification</code> object that describes the result of verifying the commit's signature. The following fields are included in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>verified</code></td><td><code>boolean</code></td><td>Indicates whether GitHub considers the signature in this commit to be verified.</td></tr><tr><td><code>reason</code></td><td><code>string</code></td><td>The reason for verified value. Possible values and their meanings are enumerated in the table below.</td></tr><tr><td><code>signature</code></td><td><code>string</code></td><td>The signature that was extracted from the commit.</td></tr><tr><td><code>payload</code></td><td><code>string</code></td><td>The value that was signed.</td></tr></tbody></table>\n<p>These are the possible values for <code>reason</code> in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td><code>expired_key</code></td><td>The key that made the signature is expired.</td></tr><tr><td><code>not_signing_key</code></td><td>The \"signing\" flag is not among the usage flags in the GPG key that made the signature.</td></tr><tr><td><code>gpgverify_error</code></td><td>There was an error communicating with the signature verification service.</td></tr><tr><td><code>gpgverify_unavailable</code></td><td>The signature verification service is currently unavailable.</td></tr><tr><td><code>unsigned</code></td><td>The object does not include a signature.</td></tr><tr><td><code>unknown_signature_type</code></td><td>A non-PGP signature was found in the commit.</td></tr><tr><td><code>no_user</code></td><td>No user was associated with the <code>committer</code> email address in the commit.</td></tr><tr><td><code>unverified_email</code></td><td>The <code>committer</code> email address in the commit was associated with a user, but the email address is not verified on her/his account.</td></tr><tr><td><code>bad_email</code></td><td>The <code>committer</code> email address in the commit is not included in the identities of the PGP key that made the signature.</td></tr><tr><td><code>unknown_key</code></td><td>The key that made the signature has not been registered with any user's account.</td></tr><tr><td><code>malformed_signature</code></td><td>There was an error parsing the signature.</td></tr><tr><td><code>invalid</code></td><td>The signature could not be cryptographically verified using the key whose key-id was found in the signature.</td></tr><tr><td><code>valid</code></td><td>None of the above errors applied, so the signature is considered to be verified.</td></tr></tbody></table>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "201",
|
||||
@@ -37817,7 +37778,7 @@
|
||||
"subcategory": "commits",
|
||||
"notes": [],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Gets a Git <a href=\"https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects\">commit object</a>.</p>\n<p><strong>Signature verification object</strong></p>\n<p>The response will include a <code>verification</code> object that describes the result of verifying the commit's signature. The following fields are included in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>verified</code></td><td><code>boolean</code></td><td>Indicates whether GitHub considers the signature in this commit to be verified.</td></tr><tr><td><code>reason</code></td><td><code>string</code></td><td>The reason for verified value. Possible values and their meanings are enumerated in table below.</td></tr><tr><td><code>signature</code></td><td><code>string</code></td><td>The signature that was extracted from the commit.</td></tr><tr><td><code>payload</code></td><td><code>string</code></td><td>The value that was signed.</td></tr></tbody></table>\n<p>These are the possible values for <code>reason</code> in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td><code>expired_key</code></td><td>The key that made the signature is expired.</td></tr><tr><td><code>not_signing_key</code></td><td>The \"signing\" flag is not among the usage flags in the GPG key that made the signature.</td></tr><tr><td><code>gpgverify_error</code></td><td>There was an error communicating with the signature verification service.</td></tr><tr><td><code>gpgverify_unavailable</code></td><td>The signature verification service is currently unavailable.</td></tr><tr><td><code>unsigned</code></td><td>The object does not include a signature.</td></tr><tr><td><code>unknown_signature_type</code></td><td>A non-PGP signature was found in the commit.</td></tr><tr><td><code>no_user</code></td><td>No user was associated with the <code>committer</code> email address in the commit.</td></tr><tr><td><code>unverified_email</code></td><td>The <code>committer</code> email address in the commit was associated with a user, but the email address is not verified on her/his account.</td></tr><tr><td><code>bad_email</code></td><td>The <code>committer</code> email address in the commit is not included in the identities of the PGP key that made the signature.</td></tr><tr><td><code>unknown_key</code></td><td>The key that made the signature has not been registered with any user's account.</td></tr><tr><td><code>malformed_signature</code></td><td>There was an error parsing the signature.</td></tr><tr><td><code>invalid</code></td><td>The signature could not be cryptographically verified using the key whose key-id was found in the signature.</td></tr><tr><td><code>valid</code></td><td>None of the above errors applied, so the signature is considered to be verified.</td></tr></tbody></table>",
|
||||
"descriptionHTML": "<p>Gets a Git <a href=\"https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects\">commit object</a>.</p>\n<p><strong>Signature verification object</strong></p>\n<p>The response will include a <code>verification</code> object that describes the result of verifying the commit's signature. The following fields are included in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>verified</code></td><td><code>boolean</code></td><td>Indicates whether GitHub considers the signature in this commit to be verified.</td></tr><tr><td><code>reason</code></td><td><code>string</code></td><td>The reason for verified value. Possible values and their meanings are enumerated in the table below.</td></tr><tr><td><code>signature</code></td><td><code>string</code></td><td>The signature that was extracted from the commit.</td></tr><tr><td><code>payload</code></td><td><code>string</code></td><td>The value that was signed.</td></tr></tbody></table>\n<p>These are the possible values for <code>reason</code> in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td><code>expired_key</code></td><td>The key that made the signature is expired.</td></tr><tr><td><code>not_signing_key</code></td><td>The \"signing\" flag is not among the usage flags in the GPG key that made the signature.</td></tr><tr><td><code>gpgverify_error</code></td><td>There was an error communicating with the signature verification service.</td></tr><tr><td><code>gpgverify_unavailable</code></td><td>The signature verification service is currently unavailable.</td></tr><tr><td><code>unsigned</code></td><td>The object does not include a signature.</td></tr><tr><td><code>unknown_signature_type</code></td><td>A non-PGP signature was found in the commit.</td></tr><tr><td><code>no_user</code></td><td>No user was associated with the <code>committer</code> email address in the commit.</td></tr><tr><td><code>unverified_email</code></td><td>The <code>committer</code> email address in the commit was associated with a user, but the email address is not verified on her/his account.</td></tr><tr><td><code>bad_email</code></td><td>The <code>committer</code> email address in the commit is not included in the identities of the PGP key that made the signature.</td></tr><tr><td><code>unknown_key</code></td><td>The key that made the signature has not been registered with any user's account.</td></tr><tr><td><code>malformed_signature</code></td><td>There was an error parsing the signature.</td></tr><tr><td><code>invalid</code></td><td>The signature could not be cryptographically verified using the key whose key-id was found in the signature.</td></tr><tr><td><code>valid</code></td><td>None of the above errors applied, so the signature is considered to be verified.</td></tr></tbody></table>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
@@ -60449,11 +60410,6 @@
|
||||
"httpStatusCode": "404",
|
||||
"httpStatusMessage": "Not Found",
|
||||
"description": "<p>Resource not found</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "415",
|
||||
"httpStatusMessage": "Unsupported Media Type",
|
||||
"description": "<p>Preview header missing</p>"
|
||||
}
|
||||
]
|
||||
},
|
||||
@@ -61576,7 +61532,7 @@
|
||||
},
|
||||
"visibility": {
|
||||
"type": "string",
|
||||
"description": "<p>Can be <code>public</code> or <code>private</code>. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, <code>visibility</code> can also be <code>internal</code>.\"</p>",
|
||||
"description": "<p>Can be <code>public</code> or <code>private</code>. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, <code>visibility</code> can also be <code>internal</code>. The <code>visibility</code> parameter overrides the <code>private</code> parameter when you use both along with the <code>nebula-preview</code> preview header.</p>",
|
||||
"enum": [
|
||||
"public",
|
||||
"private",
|
||||
@@ -61585,7 +61541,7 @@
|
||||
"name": "visibility",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
"rawDescription": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`.\"",
|
||||
"rawDescription": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. The `visibility` parameter overrides the `private` parameter when you use both along with the `nebula-preview` preview header.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
"has_issues": {
|
||||
@@ -61797,7 +61753,7 @@
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"description": "<p>Can be <code>public</code> or <code>private</code>. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, <code>visibility</code> can also be <code>internal</code>.\"</p>",
|
||||
"description": "<p>Can be <code>public</code> or <code>private</code>. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, <code>visibility</code> can also be <code>internal</code>. The <code>visibility</code> parameter overrides the <code>private</code> parameter when you use both along with the <code>nebula-preview</code> preview header.</p>",
|
||||
"enum": [
|
||||
"public",
|
||||
"private",
|
||||
@@ -61806,7 +61762,7 @@
|
||||
"name": "visibility",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
"rawDescription": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`.\"",
|
||||
"rawDescription": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. The `visibility` parameter overrides the `private` parameter when you use both along with the `nebula-preview` preview header.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
@@ -68488,11 +68444,6 @@
|
||||
"httpStatusMessage": "Not Found",
|
||||
"description": "<p>Resource not found</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "415",
|
||||
"httpStatusMessage": "Unsupported Media Type",
|
||||
"description": "<p>Preview header missing</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "422",
|
||||
"httpStatusMessage": "Unprocessable Entity",
|
||||
|
||||
@@ -10891,11 +10891,6 @@
|
||||
"httpStatusCode": "404",
|
||||
"httpStatusMessage": "Not Found",
|
||||
"description": "<p>Resource not found</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "415",
|
||||
"httpStatusMessage": "Unsupported Media Type",
|
||||
"description": "<p>Preview header missing</p>"
|
||||
}
|
||||
],
|
||||
"subcategory": "apps"
|
||||
@@ -11902,11 +11897,6 @@
|
||||
"httpStatusMessage": "Not Found",
|
||||
"description": "<p>Resource not found</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "415",
|
||||
"httpStatusMessage": "Unsupported Media Type",
|
||||
"description": "<p>Preview header missing</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "422",
|
||||
"httpStatusMessage": "Unprocessable Entity",
|
||||
@@ -12940,11 +12930,6 @@
|
||||
"httpStatusCode": "404",
|
||||
"httpStatusMessage": "Not Found",
|
||||
"description": "<p>Resource not found</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "415",
|
||||
"httpStatusMessage": "Unsupported Media Type",
|
||||
"description": "<p>Preview header missing</p>"
|
||||
}
|
||||
],
|
||||
"subcategory": "apps"
|
||||
@@ -13455,11 +13440,6 @@
|
||||
"httpStatusCode": "403",
|
||||
"httpStatusMessage": "Forbidden",
|
||||
"description": "<p>Forbidden</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "415",
|
||||
"httpStatusMessage": "Unsupported Media Type",
|
||||
"description": "<p>Preview header missing</p>"
|
||||
}
|
||||
]
|
||||
},
|
||||
@@ -16784,11 +16764,6 @@
|
||||
"httpStatusCode": "404",
|
||||
"httpStatusMessage": "Not Found",
|
||||
"description": "<p>Resource not found</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "415",
|
||||
"httpStatusMessage": "Unsupported Media Type",
|
||||
"description": "<p>Preview header missing</p>"
|
||||
}
|
||||
],
|
||||
"subcategory": "branches"
|
||||
@@ -17376,6 +17351,15 @@
|
||||
"rawDescription": "Allows deletion of the protected branch by anyone with write access to the repository. Set to `false` to prevent deletion of the protected branch. Default: `false`. For more information, see \"[Enabling force pushes to a protected branch](https://docs.github.com/en/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)\" in the GitHub Help documentation.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
"block_creations": {
|
||||
"type": "boolean",
|
||||
"description": "<p>Blocks creation of new branches which match the branch protection pattern. Set to <code>true</code> to prohibit new branch creation. Default: <code>false</code>.</p>",
|
||||
"name": "block_creations",
|
||||
"in": "body",
|
||||
"rawType": "boolean",
|
||||
"rawDescription": "Blocks creation of new branches which match the branch protection pattern. Set to `true` to prohibit new branch creation. Default: `false`.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
"required_conversation_resolution": {
|
||||
"type": "boolean",
|
||||
"description": "<p>Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to <code>false</code> to disable. Default: <code>false</code>.</p>",
|
||||
@@ -17448,6 +17432,7 @@
|
||||
"required_linear_history": true,
|
||||
"allow_force_pushes": true,
|
||||
"allow_deletions": true,
|
||||
"block_creations": true,
|
||||
"required_conversation_resolution": true
|
||||
}
|
||||
}
|
||||
@@ -17669,6 +17654,15 @@
|
||||
"rawDescription": "Allows deletion of the protected branch by anyone with write access to the repository. Set to `false` to prevent deletion of the protected branch. Default: `false`. For more information, see \"[Enabling force pushes to a protected branch](https://docs.github.com/en/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)\" in the GitHub Help documentation.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"type": "boolean",
|
||||
"description": "<p>Blocks creation of new branches which match the branch protection pattern. Set to <code>true</code> to prohibit new branch creation. Default: <code>false</code>.</p>",
|
||||
"name": "block_creations",
|
||||
"in": "body",
|
||||
"rawType": "boolean",
|
||||
"rawDescription": "Blocks creation of new branches which match the branch protection pattern. Set to `true` to prohibit new branch creation. Default: `false`.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"type": "boolean",
|
||||
"description": "<p>Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to <code>false</code> to disable. Default: <code>false</code>.</p>",
|
||||
@@ -31921,17 +31915,6 @@
|
||||
"verb": "get",
|
||||
"requestPath": "/admin/hooks",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "accept",
|
||||
"description": "This API is under preview and subject to change.",
|
||||
"in": "header",
|
||||
"schema": {
|
||||
"type": "string",
|
||||
"default": "application/vnd.github.superpro-preview+json"
|
||||
},
|
||||
"required": true,
|
||||
"descriptionHTML": "<p>This API is under preview and subject to change.</p>"
|
||||
},
|
||||
{
|
||||
"name": "per_page",
|
||||
"description": "Results per page (max 100)",
|
||||
@@ -32710,17 +32693,6 @@
|
||||
"verb": "delete",
|
||||
"requestPath": "/admin/hooks/{hook_id}",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "accept",
|
||||
"description": "This API is under preview and subject to change.",
|
||||
"in": "header",
|
||||
"schema": {
|
||||
"type": "string",
|
||||
"default": "application/vnd.github.superpro-preview+json"
|
||||
},
|
||||
"required": true,
|
||||
"descriptionHTML": "<p>This API is under preview and subject to change.</p>"
|
||||
},
|
||||
{
|
||||
"name": "hook_id",
|
||||
"in": "path",
|
||||
@@ -32771,17 +32743,6 @@
|
||||
"verb": "post",
|
||||
"requestPath": "/admin/hooks/{hook_id}/pings",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "accept",
|
||||
"description": "This API is under preview and subject to change.",
|
||||
"in": "header",
|
||||
"schema": {
|
||||
"type": "string",
|
||||
"default": "application/vnd.github.superpro-preview+json"
|
||||
},
|
||||
"required": true,
|
||||
"descriptionHTML": "<p>This API is under preview and subject to change.</p>"
|
||||
},
|
||||
{
|
||||
"name": "hook_id",
|
||||
"in": "path",
|
||||
@@ -38866,7 +38827,7 @@
|
||||
"category": "git",
|
||||
"subcategory": "commits",
|
||||
"notes": [],
|
||||
"descriptionHTML": "<p>Creates a new Git <a href=\"https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects\">commit object</a>.</p>\n<p><strong>Signature verification object</strong></p>\n<p>The response will include a <code>verification</code> object that describes the result of verifying the commit's signature. The following fields are included in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>verified</code></td><td><code>boolean</code></td><td>Indicates whether GitHub considers the signature in this commit to be verified.</td></tr><tr><td><code>reason</code></td><td><code>string</code></td><td>The reason for verified value. Possible values and their meanings are enumerated in table below.</td></tr><tr><td><code>signature</code></td><td><code>string</code></td><td>The signature that was extracted from the commit.</td></tr><tr><td><code>payload</code></td><td><code>string</code></td><td>The value that was signed.</td></tr></tbody></table>\n<p>These are the possible values for <code>reason</code> in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td><code>expired_key</code></td><td>The key that made the signature is expired.</td></tr><tr><td><code>not_signing_key</code></td><td>The \"signing\" flag is not among the usage flags in the GPG key that made the signature.</td></tr><tr><td><code>gpgverify_error</code></td><td>There was an error communicating with the signature verification service.</td></tr><tr><td><code>gpgverify_unavailable</code></td><td>The signature verification service is currently unavailable.</td></tr><tr><td><code>unsigned</code></td><td>The object does not include a signature.</td></tr><tr><td><code>unknown_signature_type</code></td><td>A non-PGP signature was found in the commit.</td></tr><tr><td><code>no_user</code></td><td>No user was associated with the <code>committer</code> email address in the commit.</td></tr><tr><td><code>unverified_email</code></td><td>The <code>committer</code> email address in the commit was associated with a user, but the email address is not verified on her/his account.</td></tr><tr><td><code>bad_email</code></td><td>The <code>committer</code> email address in the commit is not included in the identities of the PGP key that made the signature.</td></tr><tr><td><code>unknown_key</code></td><td>The key that made the signature has not been registered with any user's account.</td></tr><tr><td><code>malformed_signature</code></td><td>There was an error parsing the signature.</td></tr><tr><td><code>invalid</code></td><td>The signature could not be cryptographically verified using the key whose key-id was found in the signature.</td></tr><tr><td><code>valid</code></td><td>None of the above errors applied, so the signature is considered to be verified.</td></tr></tbody></table>",
|
||||
"descriptionHTML": "<p>Creates a new Git <a href=\"https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects\">commit object</a>.</p>\n<p><strong>Signature verification object</strong></p>\n<p>The response will include a <code>verification</code> object that describes the result of verifying the commit's signature. The following fields are included in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>verified</code></td><td><code>boolean</code></td><td>Indicates whether GitHub considers the signature in this commit to be verified.</td></tr><tr><td><code>reason</code></td><td><code>string</code></td><td>The reason for verified value. Possible values and their meanings are enumerated in the table below.</td></tr><tr><td><code>signature</code></td><td><code>string</code></td><td>The signature that was extracted from the commit.</td></tr><tr><td><code>payload</code></td><td><code>string</code></td><td>The value that was signed.</td></tr></tbody></table>\n<p>These are the possible values for <code>reason</code> in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td><code>expired_key</code></td><td>The key that made the signature is expired.</td></tr><tr><td><code>not_signing_key</code></td><td>The \"signing\" flag is not among the usage flags in the GPG key that made the signature.</td></tr><tr><td><code>gpgverify_error</code></td><td>There was an error communicating with the signature verification service.</td></tr><tr><td><code>gpgverify_unavailable</code></td><td>The signature verification service is currently unavailable.</td></tr><tr><td><code>unsigned</code></td><td>The object does not include a signature.</td></tr><tr><td><code>unknown_signature_type</code></td><td>A non-PGP signature was found in the commit.</td></tr><tr><td><code>no_user</code></td><td>No user was associated with the <code>committer</code> email address in the commit.</td></tr><tr><td><code>unverified_email</code></td><td>The <code>committer</code> email address in the commit was associated with a user, but the email address is not verified on her/his account.</td></tr><tr><td><code>bad_email</code></td><td>The <code>committer</code> email address in the commit is not included in the identities of the PGP key that made the signature.</td></tr><tr><td><code>unknown_key</code></td><td>The key that made the signature has not been registered with any user's account.</td></tr><tr><td><code>malformed_signature</code></td><td>There was an error parsing the signature.</td></tr><tr><td><code>invalid</code></td><td>The signature could not be cryptographically verified using the key whose key-id was found in the signature.</td></tr><tr><td><code>valid</code></td><td>None of the above errors applied, so the signature is considered to be verified.</td></tr></tbody></table>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "201",
|
||||
@@ -39136,7 +39097,7 @@
|
||||
"subcategory": "commits",
|
||||
"notes": [],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Gets a Git <a href=\"https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects\">commit object</a>.</p>\n<p><strong>Signature verification object</strong></p>\n<p>The response will include a <code>verification</code> object that describes the result of verifying the commit's signature. The following fields are included in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>verified</code></td><td><code>boolean</code></td><td>Indicates whether GitHub considers the signature in this commit to be verified.</td></tr><tr><td><code>reason</code></td><td><code>string</code></td><td>The reason for verified value. Possible values and their meanings are enumerated in table below.</td></tr><tr><td><code>signature</code></td><td><code>string</code></td><td>The signature that was extracted from the commit.</td></tr><tr><td><code>payload</code></td><td><code>string</code></td><td>The value that was signed.</td></tr></tbody></table>\n<p>These are the possible values for <code>reason</code> in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td><code>expired_key</code></td><td>The key that made the signature is expired.</td></tr><tr><td><code>not_signing_key</code></td><td>The \"signing\" flag is not among the usage flags in the GPG key that made the signature.</td></tr><tr><td><code>gpgverify_error</code></td><td>There was an error communicating with the signature verification service.</td></tr><tr><td><code>gpgverify_unavailable</code></td><td>The signature verification service is currently unavailable.</td></tr><tr><td><code>unsigned</code></td><td>The object does not include a signature.</td></tr><tr><td><code>unknown_signature_type</code></td><td>A non-PGP signature was found in the commit.</td></tr><tr><td><code>no_user</code></td><td>No user was associated with the <code>committer</code> email address in the commit.</td></tr><tr><td><code>unverified_email</code></td><td>The <code>committer</code> email address in the commit was associated with a user, but the email address is not verified on her/his account.</td></tr><tr><td><code>bad_email</code></td><td>The <code>committer</code> email address in the commit is not included in the identities of the PGP key that made the signature.</td></tr><tr><td><code>unknown_key</code></td><td>The key that made the signature has not been registered with any user's account.</td></tr><tr><td><code>malformed_signature</code></td><td>There was an error parsing the signature.</td></tr><tr><td><code>invalid</code></td><td>The signature could not be cryptographically verified using the key whose key-id was found in the signature.</td></tr><tr><td><code>valid</code></td><td>None of the above errors applied, so the signature is considered to be verified.</td></tr></tbody></table>",
|
||||
"descriptionHTML": "<p>Gets a Git <a href=\"https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects\">commit object</a>.</p>\n<p><strong>Signature verification object</strong></p>\n<p>The response will include a <code>verification</code> object that describes the result of verifying the commit's signature. The following fields are included in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>verified</code></td><td><code>boolean</code></td><td>Indicates whether GitHub considers the signature in this commit to be verified.</td></tr><tr><td><code>reason</code></td><td><code>string</code></td><td>The reason for verified value. Possible values and their meanings are enumerated in the table below.</td></tr><tr><td><code>signature</code></td><td><code>string</code></td><td>The signature that was extracted from the commit.</td></tr><tr><td><code>payload</code></td><td><code>string</code></td><td>The value that was signed.</td></tr></tbody></table>\n<p>These are the possible values for <code>reason</code> in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td><code>expired_key</code></td><td>The key that made the signature is expired.</td></tr><tr><td><code>not_signing_key</code></td><td>The \"signing\" flag is not among the usage flags in the GPG key that made the signature.</td></tr><tr><td><code>gpgverify_error</code></td><td>There was an error communicating with the signature verification service.</td></tr><tr><td><code>gpgverify_unavailable</code></td><td>The signature verification service is currently unavailable.</td></tr><tr><td><code>unsigned</code></td><td>The object does not include a signature.</td></tr><tr><td><code>unknown_signature_type</code></td><td>A non-PGP signature was found in the commit.</td></tr><tr><td><code>no_user</code></td><td>No user was associated with the <code>committer</code> email address in the commit.</td></tr><tr><td><code>unverified_email</code></td><td>The <code>committer</code> email address in the commit was associated with a user, but the email address is not verified on her/his account.</td></tr><tr><td><code>bad_email</code></td><td>The <code>committer</code> email address in the commit is not included in the identities of the PGP key that made the signature.</td></tr><tr><td><code>unknown_key</code></td><td>The key that made the signature has not been registered with any user's account.</td></tr><tr><td><code>malformed_signature</code></td><td>There was an error parsing the signature.</td></tr><tr><td><code>invalid</code></td><td>The signature could not be cryptographically verified using the key whose key-id was found in the signature.</td></tr><tr><td><code>valid</code></td><td>None of the above errors applied, so the signature is considered to be verified.</td></tr></tbody></table>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
@@ -62328,11 +62289,6 @@
|
||||
"httpStatusCode": "404",
|
||||
"httpStatusMessage": "Not Found",
|
||||
"description": "<p>Resource not found</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "415",
|
||||
"httpStatusMessage": "Unsupported Media Type",
|
||||
"description": "<p>Preview header missing</p>"
|
||||
}
|
||||
]
|
||||
},
|
||||
@@ -63504,7 +63460,7 @@
|
||||
},
|
||||
"secret_scanning_push_protection": {
|
||||
"type": "object",
|
||||
"description": "Use the `status` property to enable or disable secret scanning push protection for this repository. For more information, see \"[About push protection](/enterprise-cloud@latest/early-access/code-security/secret-scanning/protecting-pushes-with-secret-scanning).\"",
|
||||
"description": "Use the `status` property to enable or disable secret scanning push protection for this repository. For more information, see \"[Protecting pushes with secret scanning](/enterprise-cloud@latest/code-security/secret-scanning/protecting-pushes-with-secret-scanning).\"",
|
||||
"properties": {
|
||||
"status": {
|
||||
"type": "string",
|
||||
@@ -63770,7 +63726,7 @@
|
||||
},
|
||||
"secret_scanning_push_protection": {
|
||||
"type": "object",
|
||||
"description": "Use the `status` property to enable or disable secret scanning push protection for this repository. For more information, see \"[About push protection](/enterprise-cloud@latest/early-access/code-security/secret-scanning/protecting-pushes-with-secret-scanning).\"",
|
||||
"description": "Use the `status` property to enable or disable secret scanning push protection for this repository. For more information, see \"[Protecting pushes with secret scanning](/enterprise-cloud@latest/code-security/secret-scanning/protecting-pushes-with-secret-scanning).\"",
|
||||
"properties": {
|
||||
"status": {
|
||||
"type": "string",
|
||||
@@ -70494,11 +70450,6 @@
|
||||
"httpStatusMessage": "Not Found",
|
||||
"description": "<p>Resource not found</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "415",
|
||||
"httpStatusMessage": "Unsupported Media Type",
|
||||
"description": "<p>Preview header missing</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "422",
|
||||
"httpStatusMessage": "Unprocessable Entity",
|
||||
|
||||
@@ -10891,11 +10891,6 @@
|
||||
"httpStatusCode": "404",
|
||||
"httpStatusMessage": "Not Found",
|
||||
"description": "<p>Resource not found</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "415",
|
||||
"httpStatusMessage": "Unsupported Media Type",
|
||||
"description": "<p>Preview header missing</p>"
|
||||
}
|
||||
],
|
||||
"subcategory": "apps"
|
||||
@@ -11902,11 +11897,6 @@
|
||||
"httpStatusMessage": "Not Found",
|
||||
"description": "<p>Resource not found</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "415",
|
||||
"httpStatusMessage": "Unsupported Media Type",
|
||||
"description": "<p>Preview header missing</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "422",
|
||||
"httpStatusMessage": "Unprocessable Entity",
|
||||
@@ -12940,11 +12930,6 @@
|
||||
"httpStatusCode": "404",
|
||||
"httpStatusMessage": "Not Found",
|
||||
"description": "<p>Resource not found</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "415",
|
||||
"httpStatusMessage": "Unsupported Media Type",
|
||||
"description": "<p>Preview header missing</p>"
|
||||
}
|
||||
],
|
||||
"subcategory": "apps"
|
||||
@@ -13449,11 +13434,6 @@
|
||||
"httpStatusCode": "403",
|
||||
"httpStatusMessage": "Forbidden",
|
||||
"description": "<p>Forbidden</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "415",
|
||||
"httpStatusMessage": "Unsupported Media Type",
|
||||
"description": "<p>Preview header missing</p>"
|
||||
}
|
||||
]
|
||||
},
|
||||
@@ -16772,11 +16752,6 @@
|
||||
"httpStatusCode": "404",
|
||||
"httpStatusMessage": "Not Found",
|
||||
"description": "<p>Resource not found</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "415",
|
||||
"httpStatusMessage": "Unsupported Media Type",
|
||||
"description": "<p>Preview header missing</p>"
|
||||
}
|
||||
],
|
||||
"subcategory": "branches"
|
||||
@@ -17463,6 +17438,15 @@
|
||||
"rawDescription": "Allows deletion of the protected branch by anyone with write access to the repository. Set to `false` to prevent deletion of the protected branch. Default: `false`. For more information, see \"[Enabling force pushes to a protected branch](https://docs.github.com/en/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)\" in the GitHub Help documentation.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
"block_creations": {
|
||||
"type": "boolean",
|
||||
"description": "<p>Blocks creation of new branches which match the branch protection pattern. Set to <code>true</code> to prohibit new branch creation. Default: <code>false</code>.</p>",
|
||||
"name": "block_creations",
|
||||
"in": "body",
|
||||
"rawType": "boolean",
|
||||
"rawDescription": "Blocks creation of new branches which match the branch protection pattern. Set to `true` to prohibit new branch creation. Default: `false`.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
"required_conversation_resolution": {
|
||||
"type": "boolean",
|
||||
"description": "<p>Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to <code>false</code> to disable. Default: <code>false</code>.</p>",
|
||||
@@ -17535,6 +17519,7 @@
|
||||
"required_linear_history": true,
|
||||
"allow_force_pushes": true,
|
||||
"allow_deletions": true,
|
||||
"block_creations": true,
|
||||
"required_conversation_resolution": true
|
||||
}
|
||||
}
|
||||
@@ -17750,6 +17735,15 @@
|
||||
"rawDescription": "Allows deletion of the protected branch by anyone with write access to the repository. Set to `false` to prevent deletion of the protected branch. Default: `false`. For more information, see \"[Enabling force pushes to a protected branch](https://docs.github.com/en/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)\" in the GitHub Help documentation.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"type": "boolean",
|
||||
"description": "<p>Blocks creation of new branches which match the branch protection pattern. Set to <code>true</code> to prohibit new branch creation. Default: <code>false</code>.</p>",
|
||||
"name": "block_creations",
|
||||
"in": "body",
|
||||
"rawType": "boolean",
|
||||
"rawDescription": "Blocks creation of new branches which match the branch protection pattern. Set to `true` to prohibit new branch creation. Default: `false`.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"type": "boolean",
|
||||
"description": "<p>Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to <code>false</code> to disable. Default: <code>false</code>.</p>",
|
||||
@@ -28436,7 +28430,7 @@
|
||||
"category": "commits",
|
||||
"notes": [],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, additionally returns open pull requests associated with the commit. The results may include open and closed pull requests. Additional preview headers may be required to see certain details for associated pull requests, such as whether a pull request is in a draft state. For more information about previews that might affect this endpoint, see the <a href=\"https://docs.github.com/enterprise-server@3.3/rest/reference/pulls#list-pull-requests\">List pull requests</a> endpoint.</p>",
|
||||
"descriptionHTML": "<p>Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, additionally returns open pull requests associated with the commit. The results may include open and closed pull requests.</p>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
@@ -32086,17 +32080,6 @@
|
||||
"verb": "get",
|
||||
"requestPath": "/admin/hooks",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "accept",
|
||||
"description": "This API is under preview and subject to change.",
|
||||
"in": "header",
|
||||
"schema": {
|
||||
"type": "string",
|
||||
"default": "application/vnd.github.superpro-preview+json"
|
||||
},
|
||||
"required": true,
|
||||
"descriptionHTML": "<p>This API is under preview and subject to change.</p>"
|
||||
},
|
||||
{
|
||||
"name": "per_page",
|
||||
"description": "Results per page (max 100)",
|
||||
@@ -32817,17 +32800,6 @@
|
||||
"verb": "delete",
|
||||
"requestPath": "/admin/hooks/{hook_id}",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "accept",
|
||||
"description": "This API is under preview and subject to change.",
|
||||
"in": "header",
|
||||
"schema": {
|
||||
"type": "string",
|
||||
"default": "application/vnd.github.superpro-preview+json"
|
||||
},
|
||||
"required": true,
|
||||
"descriptionHTML": "<p>This API is under preview and subject to change.</p>"
|
||||
},
|
||||
{
|
||||
"name": "hook_id",
|
||||
"in": "path",
|
||||
@@ -32872,17 +32844,6 @@
|
||||
"verb": "post",
|
||||
"requestPath": "/admin/hooks/{hook_id}/pings",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "accept",
|
||||
"description": "This API is under preview and subject to change.",
|
||||
"in": "header",
|
||||
"schema": {
|
||||
"type": "string",
|
||||
"default": "application/vnd.github.superpro-preview+json"
|
||||
},
|
||||
"required": true,
|
||||
"descriptionHTML": "<p>This API is under preview and subject to change.</p>"
|
||||
},
|
||||
{
|
||||
"name": "hook_id",
|
||||
"in": "path",
|
||||
@@ -38835,7 +38796,7 @@
|
||||
"category": "git",
|
||||
"subcategory": "commits",
|
||||
"notes": [],
|
||||
"descriptionHTML": "<p>Creates a new Git <a href=\"https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects\">commit object</a>.</p>\n<p><strong>Signature verification object</strong></p>\n<p>The response will include a <code>verification</code> object that describes the result of verifying the commit's signature. The following fields are included in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>verified</code></td><td><code>boolean</code></td><td>Indicates whether GitHub considers the signature in this commit to be verified.</td></tr><tr><td><code>reason</code></td><td><code>string</code></td><td>The reason for verified value. Possible values and their meanings are enumerated in table below.</td></tr><tr><td><code>signature</code></td><td><code>string</code></td><td>The signature that was extracted from the commit.</td></tr><tr><td><code>payload</code></td><td><code>string</code></td><td>The value that was signed.</td></tr></tbody></table>\n<p>These are the possible values for <code>reason</code> in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td><code>expired_key</code></td><td>The key that made the signature is expired.</td></tr><tr><td><code>not_signing_key</code></td><td>The \"signing\" flag is not among the usage flags in the GPG key that made the signature.</td></tr><tr><td><code>gpgverify_error</code></td><td>There was an error communicating with the signature verification service.</td></tr><tr><td><code>gpgverify_unavailable</code></td><td>The signature verification service is currently unavailable.</td></tr><tr><td><code>unsigned</code></td><td>The object does not include a signature.</td></tr><tr><td><code>unknown_signature_type</code></td><td>A non-PGP signature was found in the commit.</td></tr><tr><td><code>no_user</code></td><td>No user was associated with the <code>committer</code> email address in the commit.</td></tr><tr><td><code>unverified_email</code></td><td>The <code>committer</code> email address in the commit was associated with a user, but the email address is not verified on her/his account.</td></tr><tr><td><code>bad_email</code></td><td>The <code>committer</code> email address in the commit is not included in the identities of the PGP key that made the signature.</td></tr><tr><td><code>unknown_key</code></td><td>The key that made the signature has not been registered with any user's account.</td></tr><tr><td><code>malformed_signature</code></td><td>There was an error parsing the signature.</td></tr><tr><td><code>invalid</code></td><td>The signature could not be cryptographically verified using the key whose key-id was found in the signature.</td></tr><tr><td><code>valid</code></td><td>None of the above errors applied, so the signature is considered to be verified.</td></tr></tbody></table>",
|
||||
"descriptionHTML": "<p>Creates a new Git <a href=\"https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects\">commit object</a>.</p>\n<p><strong>Signature verification object</strong></p>\n<p>The response will include a <code>verification</code> object that describes the result of verifying the commit's signature. The following fields are included in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>verified</code></td><td><code>boolean</code></td><td>Indicates whether GitHub considers the signature in this commit to be verified.</td></tr><tr><td><code>reason</code></td><td><code>string</code></td><td>The reason for verified value. Possible values and their meanings are enumerated in the table below.</td></tr><tr><td><code>signature</code></td><td><code>string</code></td><td>The signature that was extracted from the commit.</td></tr><tr><td><code>payload</code></td><td><code>string</code></td><td>The value that was signed.</td></tr></tbody></table>\n<p>These are the possible values for <code>reason</code> in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td><code>expired_key</code></td><td>The key that made the signature is expired.</td></tr><tr><td><code>not_signing_key</code></td><td>The \"signing\" flag is not among the usage flags in the GPG key that made the signature.</td></tr><tr><td><code>gpgverify_error</code></td><td>There was an error communicating with the signature verification service.</td></tr><tr><td><code>gpgverify_unavailable</code></td><td>The signature verification service is currently unavailable.</td></tr><tr><td><code>unsigned</code></td><td>The object does not include a signature.</td></tr><tr><td><code>unknown_signature_type</code></td><td>A non-PGP signature was found in the commit.</td></tr><tr><td><code>no_user</code></td><td>No user was associated with the <code>committer</code> email address in the commit.</td></tr><tr><td><code>unverified_email</code></td><td>The <code>committer</code> email address in the commit was associated with a user, but the email address is not verified on her/his account.</td></tr><tr><td><code>bad_email</code></td><td>The <code>committer</code> email address in the commit is not included in the identities of the PGP key that made the signature.</td></tr><tr><td><code>unknown_key</code></td><td>The key that made the signature has not been registered with any user's account.</td></tr><tr><td><code>malformed_signature</code></td><td>There was an error parsing the signature.</td></tr><tr><td><code>invalid</code></td><td>The signature could not be cryptographically verified using the key whose key-id was found in the signature.</td></tr><tr><td><code>valid</code></td><td>None of the above errors applied, so the signature is considered to be verified.</td></tr></tbody></table>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "201",
|
||||
@@ -39105,7 +39066,7 @@
|
||||
"subcategory": "commits",
|
||||
"notes": [],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Gets a Git <a href=\"https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects\">commit object</a>.</p>\n<p><strong>Signature verification object</strong></p>\n<p>The response will include a <code>verification</code> object that describes the result of verifying the commit's signature. The following fields are included in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>verified</code></td><td><code>boolean</code></td><td>Indicates whether GitHub considers the signature in this commit to be verified.</td></tr><tr><td><code>reason</code></td><td><code>string</code></td><td>The reason for verified value. Possible values and their meanings are enumerated in table below.</td></tr><tr><td><code>signature</code></td><td><code>string</code></td><td>The signature that was extracted from the commit.</td></tr><tr><td><code>payload</code></td><td><code>string</code></td><td>The value that was signed.</td></tr></tbody></table>\n<p>These are the possible values for <code>reason</code> in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td><code>expired_key</code></td><td>The key that made the signature is expired.</td></tr><tr><td><code>not_signing_key</code></td><td>The \"signing\" flag is not among the usage flags in the GPG key that made the signature.</td></tr><tr><td><code>gpgverify_error</code></td><td>There was an error communicating with the signature verification service.</td></tr><tr><td><code>gpgverify_unavailable</code></td><td>The signature verification service is currently unavailable.</td></tr><tr><td><code>unsigned</code></td><td>The object does not include a signature.</td></tr><tr><td><code>unknown_signature_type</code></td><td>A non-PGP signature was found in the commit.</td></tr><tr><td><code>no_user</code></td><td>No user was associated with the <code>committer</code> email address in the commit.</td></tr><tr><td><code>unverified_email</code></td><td>The <code>committer</code> email address in the commit was associated with a user, but the email address is not verified on her/his account.</td></tr><tr><td><code>bad_email</code></td><td>The <code>committer</code> email address in the commit is not included in the identities of the PGP key that made the signature.</td></tr><tr><td><code>unknown_key</code></td><td>The key that made the signature has not been registered with any user's account.</td></tr><tr><td><code>malformed_signature</code></td><td>There was an error parsing the signature.</td></tr><tr><td><code>invalid</code></td><td>The signature could not be cryptographically verified using the key whose key-id was found in the signature.</td></tr><tr><td><code>valid</code></td><td>None of the above errors applied, so the signature is considered to be verified.</td></tr></tbody></table>",
|
||||
"descriptionHTML": "<p>Gets a Git <a href=\"https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects\">commit object</a>.</p>\n<p><strong>Signature verification object</strong></p>\n<p>The response will include a <code>verification</code> object that describes the result of verifying the commit's signature. The following fields are included in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>verified</code></td><td><code>boolean</code></td><td>Indicates whether GitHub considers the signature in this commit to be verified.</td></tr><tr><td><code>reason</code></td><td><code>string</code></td><td>The reason for verified value. Possible values and their meanings are enumerated in the table below.</td></tr><tr><td><code>signature</code></td><td><code>string</code></td><td>The signature that was extracted from the commit.</td></tr><tr><td><code>payload</code></td><td><code>string</code></td><td>The value that was signed.</td></tr></tbody></table>\n<p>These are the possible values for <code>reason</code> in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td><code>expired_key</code></td><td>The key that made the signature is expired.</td></tr><tr><td><code>not_signing_key</code></td><td>The \"signing\" flag is not among the usage flags in the GPG key that made the signature.</td></tr><tr><td><code>gpgverify_error</code></td><td>There was an error communicating with the signature verification service.</td></tr><tr><td><code>gpgverify_unavailable</code></td><td>The signature verification service is currently unavailable.</td></tr><tr><td><code>unsigned</code></td><td>The object does not include a signature.</td></tr><tr><td><code>unknown_signature_type</code></td><td>A non-PGP signature was found in the commit.</td></tr><tr><td><code>no_user</code></td><td>No user was associated with the <code>committer</code> email address in the commit.</td></tr><tr><td><code>unverified_email</code></td><td>The <code>committer</code> email address in the commit was associated with a user, but the email address is not verified on her/his account.</td></tr><tr><td><code>bad_email</code></td><td>The <code>committer</code> email address in the commit is not included in the identities of the PGP key that made the signature.</td></tr><tr><td><code>unknown_key</code></td><td>The key that made the signature has not been registered with any user's account.</td></tr><tr><td><code>malformed_signature</code></td><td>There was an error parsing the signature.</td></tr><tr><td><code>invalid</code></td><td>The signature could not be cryptographically verified using the key whose key-id was found in the signature.</td></tr><tr><td><code>valid</code></td><td>None of the above errors applied, so the signature is considered to be verified.</td></tr></tbody></table>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
@@ -52894,11 +52855,6 @@
|
||||
"httpStatusMessage": "Forbidden",
|
||||
"description": "<p>Forbidden</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "415",
|
||||
"httpStatusMessage": "Unsupported Media Type",
|
||||
"description": "<p>Preview header missing</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "422",
|
||||
"httpStatusMessage": "Unprocessable Entity",
|
||||
@@ -56394,16 +56350,16 @@
|
||||
},
|
||||
"position": {
|
||||
"type": "integer",
|
||||
"description": "<p><strong>Required without <code>comfort-fade</code> preview unless using <code>in_reply_to</code></strong>. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.</p>",
|
||||
"description": "<p>The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.</p>",
|
||||
"name": "position",
|
||||
"in": "body",
|
||||
"rawType": "integer",
|
||||
"rawDescription": "**Required without `comfort-fade` preview unless using `in_reply_to`**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.",
|
||||
"rawDescription": "The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
"side": {
|
||||
"type": "string",
|
||||
"description": "<p><strong>Required with <code>comfort-fade</code> preview unless using <code>in_reply_to</code></strong>. In a split diff view, the side of the diff that the pull request's changes appear on. Can be <code>LEFT</code> or <code>RIGHT</code>. Use <code>LEFT</code> for deletions that appear in red. Use <code>RIGHT</code> for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"<a href=\"https://docs.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options\">Diff view options</a>\" in the GitHub Help documentation.</p>",
|
||||
"description": "<p>In a split diff view, the side of the diff that the pull request's changes appear on. Can be <code>LEFT</code> or <code>RIGHT</code>. Use <code>LEFT</code> for deletions that appear in red. Use <code>RIGHT</code> for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"<a href=\"https://docs.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options\">Diff view options</a>\" in the GitHub Help documentation.</p>",
|
||||
"enum": [
|
||||
"LEFT",
|
||||
"RIGHT"
|
||||
@@ -56411,30 +56367,30 @@
|
||||
"name": "side",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
"rawDescription": "**Required with `comfort-fade` preview unless using `in_reply_to`**. In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"[Diff view options](https://docs.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation.",
|
||||
"rawDescription": "In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"[Diff view options](https://docs.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
"line": {
|
||||
"type": "integer",
|
||||
"description": "<p><strong>Required with <code>comfort-fade</code> preview unless using <code>in_reply_to</code></strong>. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.</p>",
|
||||
"description": "<p>The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.</p>",
|
||||
"name": "line",
|
||||
"in": "body",
|
||||
"rawType": "integer",
|
||||
"rawDescription": "**Required with `comfort-fade` preview unless using `in_reply_to`**. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.",
|
||||
"rawDescription": "The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
"start_line": {
|
||||
"type": "integer",
|
||||
"description": "<p><strong>Required when using multi-line comments unless using <code>in_reply_to</code></strong>. To create multi-line comments, you must use the <code>comfort-fade</code> preview header. The <code>start_line</code> is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"<a href=\"https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request\">Commenting on a pull request</a>\" in the GitHub Help documentation.</p>",
|
||||
"description": "<p><strong>Required when using multi-line comments unless using <code>in_reply_to</code></strong>. The <code>start_line</code> is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"<a href=\"https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request\">Commenting on a pull request</a>\" in the GitHub Help documentation.</p>",
|
||||
"name": "start_line",
|
||||
"in": "body",
|
||||
"rawType": "integer",
|
||||
"rawDescription": "**Required when using multi-line comments unless using `in_reply_to`**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation.",
|
||||
"rawDescription": "**Required when using multi-line comments unless using `in_reply_to`**. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
"start_side": {
|
||||
"type": "string",
|
||||
"description": "<p><strong>Required when using multi-line comments unless using <code>in_reply_to</code></strong>. To create multi-line comments, you must use the <code>comfort-fade</code> preview header. The <code>start_side</code> is the starting side of the diff that the comment applies to. Can be <code>LEFT</code> or <code>RIGHT</code>. To learn more about multi-line comments, see \"<a href=\"https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request\">Commenting on a pull request</a>\" in the GitHub Help documentation. See <code>side</code> in this table for additional context.</p>",
|
||||
"description": "<p><strong>Required when using multi-line comments unless using <code>in_reply_to</code></strong>. The <code>start_side</code> is the starting side of the diff that the comment applies to. Can be <code>LEFT</code> or <code>RIGHT</code>. To learn more about multi-line comments, see \"<a href=\"https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request\">Commenting on a pull request</a>\" in the GitHub Help documentation. See <code>side</code> in this table for additional context.</p>",
|
||||
"enum": [
|
||||
"LEFT",
|
||||
"RIGHT",
|
||||
@@ -56443,7 +56399,7 @@
|
||||
"name": "start_side",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
"rawDescription": "**Required when using multi-line comments unless using `in_reply_to`**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.",
|
||||
"rawDescription": "**Required when using multi-line comments unless using `in_reply_to`**. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
"in_reply_to": {
|
||||
@@ -56539,16 +56495,16 @@
|
||||
},
|
||||
{
|
||||
"type": "integer",
|
||||
"description": "<p><strong>Required without <code>comfort-fade</code> preview unless using <code>in_reply_to</code></strong>. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.</p>",
|
||||
"description": "<p>The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.</p>",
|
||||
"name": "position",
|
||||
"in": "body",
|
||||
"rawType": "integer",
|
||||
"rawDescription": "**Required without `comfort-fade` preview unless using `in_reply_to`**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.",
|
||||
"rawDescription": "The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"description": "<p><strong>Required with <code>comfort-fade</code> preview unless using <code>in_reply_to</code></strong>. In a split diff view, the side of the diff that the pull request's changes appear on. Can be <code>LEFT</code> or <code>RIGHT</code>. Use <code>LEFT</code> for deletions that appear in red. Use <code>RIGHT</code> for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"<a href=\"https://docs.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options\">Diff view options</a>\" in the GitHub Help documentation.</p>",
|
||||
"description": "<p>In a split diff view, the side of the diff that the pull request's changes appear on. Can be <code>LEFT</code> or <code>RIGHT</code>. Use <code>LEFT</code> for deletions that appear in red. Use <code>RIGHT</code> for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"<a href=\"https://docs.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options\">Diff view options</a>\" in the GitHub Help documentation.</p>",
|
||||
"enum": [
|
||||
"LEFT",
|
||||
"RIGHT"
|
||||
@@ -56556,30 +56512,30 @@
|
||||
"name": "side",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
"rawDescription": "**Required with `comfort-fade` preview unless using `in_reply_to`**. In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"[Diff view options](https://docs.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation.",
|
||||
"rawDescription": "In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"[Diff view options](https://docs.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"type": "integer",
|
||||
"description": "<p><strong>Required with <code>comfort-fade</code> preview unless using <code>in_reply_to</code></strong>. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.</p>",
|
||||
"description": "<p>The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.</p>",
|
||||
"name": "line",
|
||||
"in": "body",
|
||||
"rawType": "integer",
|
||||
"rawDescription": "**Required with `comfort-fade` preview unless using `in_reply_to`**. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.",
|
||||
"rawDescription": "The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"type": "integer",
|
||||
"description": "<p><strong>Required when using multi-line comments unless using <code>in_reply_to</code></strong>. To create multi-line comments, you must use the <code>comfort-fade</code> preview header. The <code>start_line</code> is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"<a href=\"https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request\">Commenting on a pull request</a>\" in the GitHub Help documentation.</p>",
|
||||
"description": "<p><strong>Required when using multi-line comments unless using <code>in_reply_to</code></strong>. The <code>start_line</code> is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"<a href=\"https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request\">Commenting on a pull request</a>\" in the GitHub Help documentation.</p>",
|
||||
"name": "start_line",
|
||||
"in": "body",
|
||||
"rawType": "integer",
|
||||
"rawDescription": "**Required when using multi-line comments unless using `in_reply_to`**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation.",
|
||||
"rawDescription": "**Required when using multi-line comments unless using `in_reply_to`**. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"description": "<p><strong>Required when using multi-line comments unless using <code>in_reply_to</code></strong>. To create multi-line comments, you must use the <code>comfort-fade</code> preview header. The <code>start_side</code> is the starting side of the diff that the comment applies to. Can be <code>LEFT</code> or <code>RIGHT</code>. To learn more about multi-line comments, see \"<a href=\"https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request\">Commenting on a pull request</a>\" in the GitHub Help documentation. See <code>side</code> in this table for additional context.</p>",
|
||||
"description": "<p><strong>Required when using multi-line comments unless using <code>in_reply_to</code></strong>. The <code>start_side</code> is the starting side of the diff that the comment applies to. Can be <code>LEFT</code> or <code>RIGHT</code>. To learn more about multi-line comments, see \"<a href=\"https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request\">Commenting on a pull request</a>\" in the GitHub Help documentation. See <code>side</code> in this table for additional context.</p>",
|
||||
"enum": [
|
||||
"LEFT",
|
||||
"RIGHT",
|
||||
@@ -56588,7 +56544,7 @@
|
||||
"name": "start_side",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
"rawDescription": "**Required when using multi-line comments unless using `in_reply_to`**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.",
|
||||
"rawDescription": "**Required when using multi-line comments unless using `in_reply_to`**. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
@@ -59340,11 +59296,6 @@
|
||||
"description": "<p>Reaction created</p>",
|
||||
"payload": "{\n \"id\": 1,\n \"node_id\": \"MDg6UmVhY3Rpb24x\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"content\": \"heart\",\n \"created_at\": \"2016-05-20T20:09:31Z\"\n}"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "415",
|
||||
"httpStatusMessage": "Unsupported Media Type",
|
||||
"description": "<p>Preview header missing</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "422",
|
||||
"httpStatusMessage": "Unprocessable Entity",
|
||||
@@ -60505,11 +60456,6 @@
|
||||
"httpStatusCode": "404",
|
||||
"httpStatusMessage": "Not Found",
|
||||
"description": "<p>Resource not found</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "415",
|
||||
"httpStatusMessage": "Unsupported Media Type",
|
||||
"description": "<p>Preview header missing</p>"
|
||||
}
|
||||
],
|
||||
"subcategory": "reactions"
|
||||
@@ -62153,11 +62099,6 @@
|
||||
"httpStatusCode": "404",
|
||||
"httpStatusMessage": "Not Found",
|
||||
"description": "<p>Resource not found</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "415",
|
||||
"httpStatusMessage": "Unsupported Media Type",
|
||||
"description": "<p>Preview header missing</p>"
|
||||
}
|
||||
]
|
||||
},
|
||||
@@ -63305,7 +63246,7 @@
|
||||
},
|
||||
"secret_scanning_push_protection": {
|
||||
"type": "object",
|
||||
"description": "Use the `status` property to enable or disable secret scanning push protection for this repository. For more information, see \"[About push protection](/enterprise-cloud@latest/early-access/code-security/secret-scanning/protecting-pushes-with-secret-scanning).\"",
|
||||
"description": "Use the `status` property to enable or disable secret scanning push protection for this repository. For more information, see \"[Protecting pushes with secret scanning](/enterprise-cloud@latest/code-security/secret-scanning/protecting-pushes-with-secret-scanning).\"",
|
||||
"properties": {
|
||||
"status": {
|
||||
"type": "string",
|
||||
@@ -63571,7 +63512,7 @@
|
||||
},
|
||||
"secret_scanning_push_protection": {
|
||||
"type": "object",
|
||||
"description": "Use the `status` property to enable or disable secret scanning push protection for this repository. For more information, see \"[About push protection](/enterprise-cloud@latest/early-access/code-security/secret-scanning/protecting-pushes-with-secret-scanning).\"",
|
||||
"description": "Use the `status` property to enable or disable secret scanning push protection for this repository. For more information, see \"[Protecting pushes with secret scanning](/enterprise-cloud@latest/code-security/secret-scanning/protecting-pushes-with-secret-scanning).\"",
|
||||
"properties": {
|
||||
"status": {
|
||||
"type": "string",
|
||||
@@ -70861,11 +70802,6 @@
|
||||
"httpStatusMessage": "Not Found",
|
||||
"description": "<p>Resource not found</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "415",
|
||||
"httpStatusMessage": "Unsupported Media Type",
|
||||
"description": "<p>Preview header missing</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "422",
|
||||
"httpStatusMessage": "Unprocessable Entity",
|
||||
|
||||
@@ -12221,11 +12221,6 @@
|
||||
"httpStatusCode": "404",
|
||||
"httpStatusMessage": "Not Found",
|
||||
"description": "<p>Resource not found</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "415",
|
||||
"httpStatusMessage": "Unsupported Media Type",
|
||||
"description": "<p>Preview header missing</p>"
|
||||
}
|
||||
],
|
||||
"subcategory": "apps"
|
||||
@@ -13206,11 +13201,6 @@
|
||||
"httpStatusMessage": "Not Found",
|
||||
"description": "<p>Resource not found</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "415",
|
||||
"httpStatusMessage": "Unsupported Media Type",
|
||||
"description": "<p>Preview header missing</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "422",
|
||||
"httpStatusMessage": "Unprocessable Entity",
|
||||
@@ -14218,11 +14208,6 @@
|
||||
"httpStatusCode": "404",
|
||||
"httpStatusMessage": "Not Found",
|
||||
"description": "<p>Resource not found</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "415",
|
||||
"httpStatusMessage": "Unsupported Media Type",
|
||||
"description": "<p>Preview header missing</p>"
|
||||
}
|
||||
],
|
||||
"subcategory": "apps"
|
||||
@@ -14556,11 +14541,6 @@
|
||||
"httpStatusCode": "403",
|
||||
"httpStatusMessage": "Forbidden",
|
||||
"description": "<p>Forbidden</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "415",
|
||||
"httpStatusMessage": "Unsupported Media Type",
|
||||
"description": "<p>Preview header missing</p>"
|
||||
}
|
||||
]
|
||||
},
|
||||
@@ -17646,11 +17626,6 @@
|
||||
"httpStatusCode": "404",
|
||||
"httpStatusMessage": "Not Found",
|
||||
"description": "<p>Resource not found</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "415",
|
||||
"httpStatusMessage": "Unsupported Media Type",
|
||||
"description": "<p>Preview header missing</p>"
|
||||
}
|
||||
],
|
||||
"subcategory": "branches"
|
||||
@@ -18357,6 +18332,15 @@
|
||||
"rawDescription": "Allows deletion of the protected branch by anyone with write access to the repository. Set to `false` to prevent deletion of the protected branch. Default: `false`. For more information, see \"[Enabling force pushes to a protected branch](https://docs.github.com/en/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)\" in the GitHub Help documentation.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
"block_creations": {
|
||||
"type": "boolean",
|
||||
"description": "<p>Blocks creation of new branches which match the branch protection pattern. Set to <code>true</code> to prohibit new branch creation. Default: <code>false</code>.</p>",
|
||||
"name": "block_creations",
|
||||
"in": "body",
|
||||
"rawType": "boolean",
|
||||
"rawDescription": "Blocks creation of new branches which match the branch protection pattern. Set to `true` to prohibit new branch creation. Default: `false`.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
"required_conversation_resolution": {
|
||||
"type": "boolean",
|
||||
"description": "<p>Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to <code>false</code> to disable. Default: <code>false</code>.</p>",
|
||||
@@ -18417,6 +18401,7 @@
|
||||
"required_linear_history": true,
|
||||
"allow_force_pushes": true,
|
||||
"allow_deletions": true,
|
||||
"block_creations": true,
|
||||
"required_conversation_resolution": true
|
||||
}
|
||||
}
|
||||
@@ -18652,6 +18637,15 @@
|
||||
"rawDescription": "Allows deletion of the protected branch by anyone with write access to the repository. Set to `false` to prevent deletion of the protected branch. Default: `false`. For more information, see \"[Enabling force pushes to a protected branch](https://docs.github.com/en/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)\" in the GitHub Help documentation.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"type": "boolean",
|
||||
"description": "<p>Blocks creation of new branches which match the branch protection pattern. Set to <code>true</code> to prohibit new branch creation. Default: <code>false</code>.</p>",
|
||||
"name": "block_creations",
|
||||
"in": "body",
|
||||
"rawType": "boolean",
|
||||
"rawDescription": "Blocks creation of new branches which match the branch protection pattern. Set to `true` to prohibit new branch creation. Default: `false`.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"type": "boolean",
|
||||
"description": "<p>Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to <code>false</code> to disable. Default: <code>false</code>.</p>",
|
||||
@@ -29617,7 +29611,7 @@
|
||||
"category": "commits",
|
||||
"notes": [],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, additionally returns open pull requests associated with the commit. The results may include open and closed pull requests. Additional preview headers may be required to see certain details for associated pull requests, such as whether a pull request is in a draft state. For more information about previews that might affect this endpoint, see the <a href=\"https://docs.github.com/enterprise-server@3.4/rest/reference/pulls#list-pull-requests\">List pull requests</a> endpoint.</p>",
|
||||
"descriptionHTML": "<p>Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, additionally returns open pull requests associated with the commit. The results may include open and closed pull requests.</p>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
@@ -34440,17 +34434,6 @@
|
||||
"verb": "get",
|
||||
"requestPath": "/admin/hooks",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "accept",
|
||||
"description": "This API is under preview and subject to change.",
|
||||
"in": "header",
|
||||
"schema": {
|
||||
"type": "string",
|
||||
"default": "application/vnd.github.superpro-preview+json"
|
||||
},
|
||||
"required": true,
|
||||
"descriptionHTML": "<p>This API is under preview and subject to change.</p>"
|
||||
},
|
||||
{
|
||||
"name": "per_page",
|
||||
"description": "Results per page (max 100)",
|
||||
@@ -35171,17 +35154,6 @@
|
||||
"verb": "delete",
|
||||
"requestPath": "/admin/hooks/{hook_id}",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "accept",
|
||||
"description": "This API is under preview and subject to change.",
|
||||
"in": "header",
|
||||
"schema": {
|
||||
"type": "string",
|
||||
"default": "application/vnd.github.superpro-preview+json"
|
||||
},
|
||||
"required": true,
|
||||
"descriptionHTML": "<p>This API is under preview and subject to change.</p>"
|
||||
},
|
||||
{
|
||||
"name": "hook_id",
|
||||
"in": "path",
|
||||
@@ -35226,17 +35198,6 @@
|
||||
"verb": "post",
|
||||
"requestPath": "/admin/hooks/{hook_id}/pings",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "accept",
|
||||
"description": "This API is under preview and subject to change.",
|
||||
"in": "header",
|
||||
"schema": {
|
||||
"type": "string",
|
||||
"default": "application/vnd.github.superpro-preview+json"
|
||||
},
|
||||
"required": true,
|
||||
"descriptionHTML": "<p>This API is under preview and subject to change.</p>"
|
||||
},
|
||||
{
|
||||
"name": "hook_id",
|
||||
"in": "path",
|
||||
@@ -41189,7 +41150,7 @@
|
||||
"category": "git",
|
||||
"subcategory": "commits",
|
||||
"notes": [],
|
||||
"descriptionHTML": "<p>Creates a new Git <a href=\"https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects\">commit object</a>.</p>\n<p><strong>Signature verification object</strong></p>\n<p>The response will include a <code>verification</code> object that describes the result of verifying the commit's signature. The following fields are included in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>verified</code></td><td><code>boolean</code></td><td>Indicates whether GitHub considers the signature in this commit to be verified.</td></tr><tr><td><code>reason</code></td><td><code>string</code></td><td>The reason for verified value. Possible values and their meanings are enumerated in table below.</td></tr><tr><td><code>signature</code></td><td><code>string</code></td><td>The signature that was extracted from the commit.</td></tr><tr><td><code>payload</code></td><td><code>string</code></td><td>The value that was signed.</td></tr></tbody></table>\n<p>These are the possible values for <code>reason</code> in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td><code>expired_key</code></td><td>The key that made the signature is expired.</td></tr><tr><td><code>not_signing_key</code></td><td>The \"signing\" flag is not among the usage flags in the GPG key that made the signature.</td></tr><tr><td><code>gpgverify_error</code></td><td>There was an error communicating with the signature verification service.</td></tr><tr><td><code>gpgverify_unavailable</code></td><td>The signature verification service is currently unavailable.</td></tr><tr><td><code>unsigned</code></td><td>The object does not include a signature.</td></tr><tr><td><code>unknown_signature_type</code></td><td>A non-PGP signature was found in the commit.</td></tr><tr><td><code>no_user</code></td><td>No user was associated with the <code>committer</code> email address in the commit.</td></tr><tr><td><code>unverified_email</code></td><td>The <code>committer</code> email address in the commit was associated with a user, but the email address is not verified on her/his account.</td></tr><tr><td><code>bad_email</code></td><td>The <code>committer</code> email address in the commit is not included in the identities of the PGP key that made the signature.</td></tr><tr><td><code>unknown_key</code></td><td>The key that made the signature has not been registered with any user's account.</td></tr><tr><td><code>malformed_signature</code></td><td>There was an error parsing the signature.</td></tr><tr><td><code>invalid</code></td><td>The signature could not be cryptographically verified using the key whose key-id was found in the signature.</td></tr><tr><td><code>valid</code></td><td>None of the above errors applied, so the signature is considered to be verified.</td></tr></tbody></table>",
|
||||
"descriptionHTML": "<p>Creates a new Git <a href=\"https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects\">commit object</a>.</p>\n<p><strong>Signature verification object</strong></p>\n<p>The response will include a <code>verification</code> object that describes the result of verifying the commit's signature. The following fields are included in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>verified</code></td><td><code>boolean</code></td><td>Indicates whether GitHub considers the signature in this commit to be verified.</td></tr><tr><td><code>reason</code></td><td><code>string</code></td><td>The reason for verified value. Possible values and their meanings are enumerated in the table below.</td></tr><tr><td><code>signature</code></td><td><code>string</code></td><td>The signature that was extracted from the commit.</td></tr><tr><td><code>payload</code></td><td><code>string</code></td><td>The value that was signed.</td></tr></tbody></table>\n<p>These are the possible values for <code>reason</code> in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td><code>expired_key</code></td><td>The key that made the signature is expired.</td></tr><tr><td><code>not_signing_key</code></td><td>The \"signing\" flag is not among the usage flags in the GPG key that made the signature.</td></tr><tr><td><code>gpgverify_error</code></td><td>There was an error communicating with the signature verification service.</td></tr><tr><td><code>gpgverify_unavailable</code></td><td>The signature verification service is currently unavailable.</td></tr><tr><td><code>unsigned</code></td><td>The object does not include a signature.</td></tr><tr><td><code>unknown_signature_type</code></td><td>A non-PGP signature was found in the commit.</td></tr><tr><td><code>no_user</code></td><td>No user was associated with the <code>committer</code> email address in the commit.</td></tr><tr><td><code>unverified_email</code></td><td>The <code>committer</code> email address in the commit was associated with a user, but the email address is not verified on her/his account.</td></tr><tr><td><code>bad_email</code></td><td>The <code>committer</code> email address in the commit is not included in the identities of the PGP key that made the signature.</td></tr><tr><td><code>unknown_key</code></td><td>The key that made the signature has not been registered with any user's account.</td></tr><tr><td><code>malformed_signature</code></td><td>There was an error parsing the signature.</td></tr><tr><td><code>invalid</code></td><td>The signature could not be cryptographically verified using the key whose key-id was found in the signature.</td></tr><tr><td><code>valid</code></td><td>None of the above errors applied, so the signature is considered to be verified.</td></tr></tbody></table>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "201",
|
||||
@@ -41459,7 +41420,7 @@
|
||||
"subcategory": "commits",
|
||||
"notes": [],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Gets a Git <a href=\"https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects\">commit object</a>.</p>\n<p><strong>Signature verification object</strong></p>\n<p>The response will include a <code>verification</code> object that describes the result of verifying the commit's signature. The following fields are included in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>verified</code></td><td><code>boolean</code></td><td>Indicates whether GitHub considers the signature in this commit to be verified.</td></tr><tr><td><code>reason</code></td><td><code>string</code></td><td>The reason for verified value. Possible values and their meanings are enumerated in table below.</td></tr><tr><td><code>signature</code></td><td><code>string</code></td><td>The signature that was extracted from the commit.</td></tr><tr><td><code>payload</code></td><td><code>string</code></td><td>The value that was signed.</td></tr></tbody></table>\n<p>These are the possible values for <code>reason</code> in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td><code>expired_key</code></td><td>The key that made the signature is expired.</td></tr><tr><td><code>not_signing_key</code></td><td>The \"signing\" flag is not among the usage flags in the GPG key that made the signature.</td></tr><tr><td><code>gpgverify_error</code></td><td>There was an error communicating with the signature verification service.</td></tr><tr><td><code>gpgverify_unavailable</code></td><td>The signature verification service is currently unavailable.</td></tr><tr><td><code>unsigned</code></td><td>The object does not include a signature.</td></tr><tr><td><code>unknown_signature_type</code></td><td>A non-PGP signature was found in the commit.</td></tr><tr><td><code>no_user</code></td><td>No user was associated with the <code>committer</code> email address in the commit.</td></tr><tr><td><code>unverified_email</code></td><td>The <code>committer</code> email address in the commit was associated with a user, but the email address is not verified on her/his account.</td></tr><tr><td><code>bad_email</code></td><td>The <code>committer</code> email address in the commit is not included in the identities of the PGP key that made the signature.</td></tr><tr><td><code>unknown_key</code></td><td>The key that made the signature has not been registered with any user's account.</td></tr><tr><td><code>malformed_signature</code></td><td>There was an error parsing the signature.</td></tr><tr><td><code>invalid</code></td><td>The signature could not be cryptographically verified using the key whose key-id was found in the signature.</td></tr><tr><td><code>valid</code></td><td>None of the above errors applied, so the signature is considered to be verified.</td></tr></tbody></table>",
|
||||
"descriptionHTML": "<p>Gets a Git <a href=\"https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects\">commit object</a>.</p>\n<p><strong>Signature verification object</strong></p>\n<p>The response will include a <code>verification</code> object that describes the result of verifying the commit's signature. The following fields are included in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>verified</code></td><td><code>boolean</code></td><td>Indicates whether GitHub considers the signature in this commit to be verified.</td></tr><tr><td><code>reason</code></td><td><code>string</code></td><td>The reason for verified value. Possible values and their meanings are enumerated in the table below.</td></tr><tr><td><code>signature</code></td><td><code>string</code></td><td>The signature that was extracted from the commit.</td></tr><tr><td><code>payload</code></td><td><code>string</code></td><td>The value that was signed.</td></tr></tbody></table>\n<p>These are the possible values for <code>reason</code> in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td><code>expired_key</code></td><td>The key that made the signature is expired.</td></tr><tr><td><code>not_signing_key</code></td><td>The \"signing\" flag is not among the usage flags in the GPG key that made the signature.</td></tr><tr><td><code>gpgverify_error</code></td><td>There was an error communicating with the signature verification service.</td></tr><tr><td><code>gpgverify_unavailable</code></td><td>The signature verification service is currently unavailable.</td></tr><tr><td><code>unsigned</code></td><td>The object does not include a signature.</td></tr><tr><td><code>unknown_signature_type</code></td><td>A non-PGP signature was found in the commit.</td></tr><tr><td><code>no_user</code></td><td>No user was associated with the <code>committer</code> email address in the commit.</td></tr><tr><td><code>unverified_email</code></td><td>The <code>committer</code> email address in the commit was associated with a user, but the email address is not verified on her/his account.</td></tr><tr><td><code>bad_email</code></td><td>The <code>committer</code> email address in the commit is not included in the identities of the PGP key that made the signature.</td></tr><tr><td><code>unknown_key</code></td><td>The key that made the signature has not been registered with any user's account.</td></tr><tr><td><code>malformed_signature</code></td><td>There was an error parsing the signature.</td></tr><tr><td><code>invalid</code></td><td>The signature could not be cryptographically verified using the key whose key-id was found in the signature.</td></tr><tr><td><code>valid</code></td><td>None of the above errors applied, so the signature is considered to be verified.</td></tr></tbody></table>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
@@ -56189,11 +56150,6 @@
|
||||
"httpStatusMessage": "Forbidden",
|
||||
"description": "<p>Forbidden</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "415",
|
||||
"httpStatusMessage": "Unsupported Media Type",
|
||||
"description": "<p>Preview header missing</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "422",
|
||||
"httpStatusMessage": "Unprocessable Entity",
|
||||
@@ -59689,16 +59645,16 @@
|
||||
},
|
||||
"position": {
|
||||
"type": "integer",
|
||||
"description": "<p><strong>Required without <code>comfort-fade</code> preview unless using <code>in_reply_to</code></strong>. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.</p>",
|
||||
"description": "<p>The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.</p>",
|
||||
"name": "position",
|
||||
"in": "body",
|
||||
"rawType": "integer",
|
||||
"rawDescription": "**Required without `comfort-fade` preview unless using `in_reply_to`**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.",
|
||||
"rawDescription": "The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
"side": {
|
||||
"type": "string",
|
||||
"description": "<p><strong>Required with <code>comfort-fade</code> preview unless using <code>in_reply_to</code></strong>. In a split diff view, the side of the diff that the pull request's changes appear on. Can be <code>LEFT</code> or <code>RIGHT</code>. Use <code>LEFT</code> for deletions that appear in red. Use <code>RIGHT</code> for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"<a href=\"https://docs.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options\">Diff view options</a>\" in the GitHub Help documentation.</p>",
|
||||
"description": "<p>In a split diff view, the side of the diff that the pull request's changes appear on. Can be <code>LEFT</code> or <code>RIGHT</code>. Use <code>LEFT</code> for deletions that appear in red. Use <code>RIGHT</code> for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"<a href=\"https://docs.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options\">Diff view options</a>\" in the GitHub Help documentation.</p>",
|
||||
"enum": [
|
||||
"LEFT",
|
||||
"RIGHT"
|
||||
@@ -59706,30 +59662,30 @@
|
||||
"name": "side",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
"rawDescription": "**Required with `comfort-fade` preview unless using `in_reply_to`**. In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"[Diff view options](https://docs.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation.",
|
||||
"rawDescription": "In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"[Diff view options](https://docs.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
"line": {
|
||||
"type": "integer",
|
||||
"description": "<p><strong>Required with <code>comfort-fade</code> preview unless using <code>in_reply_to</code></strong>. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.</p>",
|
||||
"description": "<p>The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.</p>",
|
||||
"name": "line",
|
||||
"in": "body",
|
||||
"rawType": "integer",
|
||||
"rawDescription": "**Required with `comfort-fade` preview unless using `in_reply_to`**. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.",
|
||||
"rawDescription": "The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
"start_line": {
|
||||
"type": "integer",
|
||||
"description": "<p><strong>Required when using multi-line comments unless using <code>in_reply_to</code></strong>. To create multi-line comments, you must use the <code>comfort-fade</code> preview header. The <code>start_line</code> is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"<a href=\"https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request\">Commenting on a pull request</a>\" in the GitHub Help documentation.</p>",
|
||||
"description": "<p><strong>Required when using multi-line comments unless using <code>in_reply_to</code></strong>. The <code>start_line</code> is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"<a href=\"https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request\">Commenting on a pull request</a>\" in the GitHub Help documentation.</p>",
|
||||
"name": "start_line",
|
||||
"in": "body",
|
||||
"rawType": "integer",
|
||||
"rawDescription": "**Required when using multi-line comments unless using `in_reply_to`**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation.",
|
||||
"rawDescription": "**Required when using multi-line comments unless using `in_reply_to`**. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
"start_side": {
|
||||
"type": "string",
|
||||
"description": "<p><strong>Required when using multi-line comments unless using <code>in_reply_to</code></strong>. To create multi-line comments, you must use the <code>comfort-fade</code> preview header. The <code>start_side</code> is the starting side of the diff that the comment applies to. Can be <code>LEFT</code> or <code>RIGHT</code>. To learn more about multi-line comments, see \"<a href=\"https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request\">Commenting on a pull request</a>\" in the GitHub Help documentation. See <code>side</code> in this table for additional context.</p>",
|
||||
"description": "<p><strong>Required when using multi-line comments unless using <code>in_reply_to</code></strong>. The <code>start_side</code> is the starting side of the diff that the comment applies to. Can be <code>LEFT</code> or <code>RIGHT</code>. To learn more about multi-line comments, see \"<a href=\"https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request\">Commenting on a pull request</a>\" in the GitHub Help documentation. See <code>side</code> in this table for additional context.</p>",
|
||||
"enum": [
|
||||
"LEFT",
|
||||
"RIGHT",
|
||||
@@ -59738,7 +59694,7 @@
|
||||
"name": "start_side",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
"rawDescription": "**Required when using multi-line comments unless using `in_reply_to`**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.",
|
||||
"rawDescription": "**Required when using multi-line comments unless using `in_reply_to`**. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
"in_reply_to": {
|
||||
@@ -59834,16 +59790,16 @@
|
||||
},
|
||||
{
|
||||
"type": "integer",
|
||||
"description": "<p><strong>Required without <code>comfort-fade</code> preview unless using <code>in_reply_to</code></strong>. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.</p>",
|
||||
"description": "<p>The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.</p>",
|
||||
"name": "position",
|
||||
"in": "body",
|
||||
"rawType": "integer",
|
||||
"rawDescription": "**Required without `comfort-fade` preview unless using `in_reply_to`**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.",
|
||||
"rawDescription": "The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"description": "<p><strong>Required with <code>comfort-fade</code> preview unless using <code>in_reply_to</code></strong>. In a split diff view, the side of the diff that the pull request's changes appear on. Can be <code>LEFT</code> or <code>RIGHT</code>. Use <code>LEFT</code> for deletions that appear in red. Use <code>RIGHT</code> for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"<a href=\"https://docs.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options\">Diff view options</a>\" in the GitHub Help documentation.</p>",
|
||||
"description": "<p>In a split diff view, the side of the diff that the pull request's changes appear on. Can be <code>LEFT</code> or <code>RIGHT</code>. Use <code>LEFT</code> for deletions that appear in red. Use <code>RIGHT</code> for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"<a href=\"https://docs.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options\">Diff view options</a>\" in the GitHub Help documentation.</p>",
|
||||
"enum": [
|
||||
"LEFT",
|
||||
"RIGHT"
|
||||
@@ -59851,30 +59807,30 @@
|
||||
"name": "side",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
"rawDescription": "**Required with `comfort-fade` preview unless using `in_reply_to`**. In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"[Diff view options](https://docs.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation.",
|
||||
"rawDescription": "In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"[Diff view options](https://docs.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"type": "integer",
|
||||
"description": "<p><strong>Required with <code>comfort-fade</code> preview unless using <code>in_reply_to</code></strong>. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.</p>",
|
||||
"description": "<p>The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.</p>",
|
||||
"name": "line",
|
||||
"in": "body",
|
||||
"rawType": "integer",
|
||||
"rawDescription": "**Required with `comfort-fade` preview unless using `in_reply_to`**. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.",
|
||||
"rawDescription": "The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"type": "integer",
|
||||
"description": "<p><strong>Required when using multi-line comments unless using <code>in_reply_to</code></strong>. To create multi-line comments, you must use the <code>comfort-fade</code> preview header. The <code>start_line</code> is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"<a href=\"https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request\">Commenting on a pull request</a>\" in the GitHub Help documentation.</p>",
|
||||
"description": "<p><strong>Required when using multi-line comments unless using <code>in_reply_to</code></strong>. The <code>start_line</code> is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"<a href=\"https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request\">Commenting on a pull request</a>\" in the GitHub Help documentation.</p>",
|
||||
"name": "start_line",
|
||||
"in": "body",
|
||||
"rawType": "integer",
|
||||
"rawDescription": "**Required when using multi-line comments unless using `in_reply_to`**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation.",
|
||||
"rawDescription": "**Required when using multi-line comments unless using `in_reply_to`**. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"description": "<p><strong>Required when using multi-line comments unless using <code>in_reply_to</code></strong>. To create multi-line comments, you must use the <code>comfort-fade</code> preview header. The <code>start_side</code> is the starting side of the diff that the comment applies to. Can be <code>LEFT</code> or <code>RIGHT</code>. To learn more about multi-line comments, see \"<a href=\"https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request\">Commenting on a pull request</a>\" in the GitHub Help documentation. See <code>side</code> in this table for additional context.</p>",
|
||||
"description": "<p><strong>Required when using multi-line comments unless using <code>in_reply_to</code></strong>. The <code>start_side</code> is the starting side of the diff that the comment applies to. Can be <code>LEFT</code> or <code>RIGHT</code>. To learn more about multi-line comments, see \"<a href=\"https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request\">Commenting on a pull request</a>\" in the GitHub Help documentation. See <code>side</code> in this table for additional context.</p>",
|
||||
"enum": [
|
||||
"LEFT",
|
||||
"RIGHT",
|
||||
@@ -59883,7 +59839,7 @@
|
||||
"name": "start_side",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
"rawDescription": "**Required when using multi-line comments unless using `in_reply_to`**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.",
|
||||
"rawDescription": "**Required when using multi-line comments unless using `in_reply_to`**. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
@@ -62635,11 +62591,6 @@
|
||||
"description": "<p>Reaction created</p>",
|
||||
"payload": "{\n \"id\": 1,\n \"node_id\": \"MDg6UmVhY3Rpb24x\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"content\": \"heart\",\n \"created_at\": \"2016-05-20T20:09:31Z\"\n}"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "415",
|
||||
"httpStatusMessage": "Unsupported Media Type",
|
||||
"description": "<p>Preview header missing</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "422",
|
||||
"httpStatusMessage": "Unprocessable Entity",
|
||||
@@ -63800,11 +63751,6 @@
|
||||
"httpStatusCode": "404",
|
||||
"httpStatusMessage": "Not Found",
|
||||
"description": "<p>Resource not found</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "415",
|
||||
"httpStatusMessage": "Unsupported Media Type",
|
||||
"description": "<p>Preview header missing</p>"
|
||||
}
|
||||
],
|
||||
"subcategory": "reactions"
|
||||
@@ -65448,11 +65394,6 @@
|
||||
"httpStatusCode": "404",
|
||||
"httpStatusMessage": "Not Found",
|
||||
"description": "<p>Resource not found</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "415",
|
||||
"httpStatusMessage": "Unsupported Media Type",
|
||||
"description": "<p>Preview header missing</p>"
|
||||
}
|
||||
]
|
||||
},
|
||||
@@ -66600,7 +66541,7 @@
|
||||
},
|
||||
"secret_scanning_push_protection": {
|
||||
"type": "object",
|
||||
"description": "Use the `status` property to enable or disable secret scanning push protection for this repository. For more information, see \"[About push protection](/enterprise-cloud@latest/early-access/code-security/secret-scanning/protecting-pushes-with-secret-scanning).\"",
|
||||
"description": "Use the `status` property to enable or disable secret scanning push protection for this repository. For more information, see \"[Protecting pushes with secret scanning](/enterprise-cloud@latest/code-security/secret-scanning/protecting-pushes-with-secret-scanning).\"",
|
||||
"properties": {
|
||||
"status": {
|
||||
"type": "string",
|
||||
@@ -66866,7 +66807,7 @@
|
||||
},
|
||||
"secret_scanning_push_protection": {
|
||||
"type": "object",
|
||||
"description": "Use the `status` property to enable or disable secret scanning push protection for this repository. For more information, see \"[About push protection](/enterprise-cloud@latest/early-access/code-security/secret-scanning/protecting-pushes-with-secret-scanning).\"",
|
||||
"description": "Use the `status` property to enable or disable secret scanning push protection for this repository. For more information, see \"[Protecting pushes with secret scanning](/enterprise-cloud@latest/code-security/secret-scanning/protecting-pushes-with-secret-scanning).\"",
|
||||
"properties": {
|
||||
"status": {
|
||||
"type": "string",
|
||||
@@ -74360,11 +74301,6 @@
|
||||
"httpStatusMessage": "Not Found",
|
||||
"description": "<p>Resource not found</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "415",
|
||||
"httpStatusMessage": "Unsupported Media Type",
|
||||
"description": "<p>Preview header missing</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "422",
|
||||
"httpStatusMessage": "Unprocessable Entity",
|
||||
|
||||
@@ -9362,11 +9362,6 @@
|
||||
"httpStatusCode": "404",
|
||||
"httpStatusMessage": "Not Found",
|
||||
"description": "<p>Resource not found</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "415",
|
||||
"httpStatusMessage": "Unsupported Media Type",
|
||||
"description": "<p>Preview header missing</p>"
|
||||
}
|
||||
],
|
||||
"subcategory": "apps"
|
||||
@@ -10347,11 +10342,6 @@
|
||||
"httpStatusMessage": "Not Found",
|
||||
"description": "<p>Resource not found</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "415",
|
||||
"httpStatusMessage": "Unsupported Media Type",
|
||||
"description": "<p>Preview header missing</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "422",
|
||||
"httpStatusMessage": "Unprocessable Entity",
|
||||
@@ -11359,11 +11349,6 @@
|
||||
"httpStatusCode": "404",
|
||||
"httpStatusMessage": "Not Found",
|
||||
"description": "<p>Resource not found</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "415",
|
||||
"httpStatusMessage": "Unsupported Media Type",
|
||||
"description": "<p>Preview header missing</p>"
|
||||
}
|
||||
],
|
||||
"subcategory": "apps"
|
||||
@@ -11697,11 +11682,6 @@
|
||||
"httpStatusCode": "403",
|
||||
"httpStatusMessage": "Forbidden",
|
||||
"description": "<p>Forbidden</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "415",
|
||||
"httpStatusMessage": "Unsupported Media Type",
|
||||
"description": "<p>Preview header missing</p>"
|
||||
}
|
||||
]
|
||||
},
|
||||
@@ -12932,11 +12912,6 @@
|
||||
"httpStatusCode": "404",
|
||||
"httpStatusMessage": "Not Found",
|
||||
"description": "<p>Resource not found</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "415",
|
||||
"httpStatusMessage": "Unsupported Media Type",
|
||||
"description": "<p>Preview header missing</p>"
|
||||
}
|
||||
],
|
||||
"subcategory": "branches"
|
||||
@@ -13522,6 +13497,15 @@
|
||||
"rawDescription": "Allows deletion of the protected branch by anyone with write access to the repository. Set to `false` to prevent deletion of the protected branch. Default: `false`. For more information, see \"[Enabling force pushes to a protected branch](https://docs.github.com/en/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)\" in the GitHub Help documentation.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
"block_creations": {
|
||||
"type": "boolean",
|
||||
"description": "<p>Blocks creation of new branches which match the branch protection pattern. Set to <code>true</code> to prohibit new branch creation. Default: <code>false</code>.</p>",
|
||||
"name": "block_creations",
|
||||
"in": "body",
|
||||
"rawType": "boolean",
|
||||
"rawDescription": "Blocks creation of new branches which match the branch protection pattern. Set to `true` to prohibit new branch creation. Default: `false`.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
"required_conversation_resolution": {
|
||||
"type": "boolean",
|
||||
"description": "<p>Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to <code>false</code> to disable. Default: <code>false</code>.</p>",
|
||||
@@ -13582,6 +13566,7 @@
|
||||
"required_linear_history": true,
|
||||
"allow_force_pushes": true,
|
||||
"allow_deletions": true,
|
||||
"block_creations": true,
|
||||
"required_conversation_resolution": true
|
||||
}
|
||||
}
|
||||
@@ -13817,6 +13802,15 @@
|
||||
"rawDescription": "Allows deletion of the protected branch by anyone with write access to the repository. Set to `false` to prevent deletion of the protected branch. Default: `false`. For more information, see \"[Enabling force pushes to a protected branch](https://docs.github.com/en/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)\" in the GitHub Help documentation.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"type": "boolean",
|
||||
"description": "<p>Blocks creation of new branches which match the branch protection pattern. Set to <code>true</code> to prohibit new branch creation. Default: <code>false</code>.</p>",
|
||||
"name": "block_creations",
|
||||
"in": "body",
|
||||
"rawType": "boolean",
|
||||
"rawDescription": "Blocks creation of new branches which match the branch protection pattern. Set to `true` to prohibit new branch creation. Default: `false`.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"type": "boolean",
|
||||
"description": "<p>Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to <code>false</code> to disable. Default: <code>false</code>.</p>",
|
||||
@@ -24741,7 +24735,7 @@
|
||||
"category": "commits",
|
||||
"notes": [],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, additionally returns open pull requests associated with the commit. The results may include open and closed pull requests. Additional preview headers may be required to see certain details for associated pull requests, such as whether a pull request is in a draft state. For more information about previews that might affect this endpoint, see the <a href=\"https://docs.github.com/github-ae@latest/rest/reference/pulls#list-pull-requests\">List pull requests</a> endpoint.</p>",
|
||||
"descriptionHTML": "<p>Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, additionally returns open pull requests associated with the commit. The results may include open and closed pull requests.</p>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
@@ -28279,17 +28273,6 @@
|
||||
"verb": "get",
|
||||
"requestPath": "/admin/hooks",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "accept",
|
||||
"description": "This API is under preview and subject to change.",
|
||||
"in": "header",
|
||||
"schema": {
|
||||
"type": "string",
|
||||
"default": "application/vnd.github.superpro-preview+json"
|
||||
},
|
||||
"required": true,
|
||||
"descriptionHTML": "<p>This API is under preview and subject to change.</p>"
|
||||
},
|
||||
{
|
||||
"name": "per_page",
|
||||
"description": "Results per page (max 100)",
|
||||
@@ -29010,17 +28993,6 @@
|
||||
"verb": "delete",
|
||||
"requestPath": "/admin/hooks/{hook_id}",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "accept",
|
||||
"description": "This API is under preview and subject to change.",
|
||||
"in": "header",
|
||||
"schema": {
|
||||
"type": "string",
|
||||
"default": "application/vnd.github.superpro-preview+json"
|
||||
},
|
||||
"required": true,
|
||||
"descriptionHTML": "<p>This API is under preview and subject to change.</p>"
|
||||
},
|
||||
{
|
||||
"name": "hook_id",
|
||||
"in": "path",
|
||||
@@ -29065,17 +29037,6 @@
|
||||
"verb": "post",
|
||||
"requestPath": "/admin/hooks/{hook_id}/pings",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "accept",
|
||||
"description": "This API is under preview and subject to change.",
|
||||
"in": "header",
|
||||
"schema": {
|
||||
"type": "string",
|
||||
"default": "application/vnd.github.superpro-preview+json"
|
||||
},
|
||||
"required": true,
|
||||
"descriptionHTML": "<p>This API is under preview and subject to change.</p>"
|
||||
},
|
||||
{
|
||||
"name": "hook_id",
|
||||
"in": "path",
|
||||
@@ -33583,7 +33544,7 @@
|
||||
"category": "git",
|
||||
"subcategory": "commits",
|
||||
"notes": [],
|
||||
"descriptionHTML": "<p>Creates a new Git <a href=\"https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects\">commit object</a>.</p>\n<p><strong>Signature verification object</strong></p>\n<p>The response will include a <code>verification</code> object that describes the result of verifying the commit's signature. The following fields are included in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>verified</code></td><td><code>boolean</code></td><td>Indicates whether GitHub considers the signature in this commit to be verified.</td></tr><tr><td><code>reason</code></td><td><code>string</code></td><td>The reason for verified value. Possible values and their meanings are enumerated in table below.</td></tr><tr><td><code>signature</code></td><td><code>string</code></td><td>The signature that was extracted from the commit.</td></tr><tr><td><code>payload</code></td><td><code>string</code></td><td>The value that was signed.</td></tr></tbody></table>\n<p>These are the possible values for <code>reason</code> in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td><code>expired_key</code></td><td>The key that made the signature is expired.</td></tr><tr><td><code>not_signing_key</code></td><td>The \"signing\" flag is not among the usage flags in the GPG key that made the signature.</td></tr><tr><td><code>gpgverify_error</code></td><td>There was an error communicating with the signature verification service.</td></tr><tr><td><code>gpgverify_unavailable</code></td><td>The signature verification service is currently unavailable.</td></tr><tr><td><code>unsigned</code></td><td>The object does not include a signature.</td></tr><tr><td><code>unknown_signature_type</code></td><td>A non-PGP signature was found in the commit.</td></tr><tr><td><code>no_user</code></td><td>No user was associated with the <code>committer</code> email address in the commit.</td></tr><tr><td><code>unverified_email</code></td><td>The <code>committer</code> email address in the commit was associated with a user, but the email address is not verified on her/his account.</td></tr><tr><td><code>bad_email</code></td><td>The <code>committer</code> email address in the commit is not included in the identities of the PGP key that made the signature.</td></tr><tr><td><code>unknown_key</code></td><td>The key that made the signature has not been registered with any user's account.</td></tr><tr><td><code>malformed_signature</code></td><td>There was an error parsing the signature.</td></tr><tr><td><code>invalid</code></td><td>The signature could not be cryptographically verified using the key whose key-id was found in the signature.</td></tr><tr><td><code>valid</code></td><td>None of the above errors applied, so the signature is considered to be verified.</td></tr></tbody></table>",
|
||||
"descriptionHTML": "<p>Creates a new Git <a href=\"https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects\">commit object</a>.</p>\n<p><strong>Signature verification object</strong></p>\n<p>The response will include a <code>verification</code> object that describes the result of verifying the commit's signature. The following fields are included in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>verified</code></td><td><code>boolean</code></td><td>Indicates whether GitHub considers the signature in this commit to be verified.</td></tr><tr><td><code>reason</code></td><td><code>string</code></td><td>The reason for verified value. Possible values and their meanings are enumerated in the table below.</td></tr><tr><td><code>signature</code></td><td><code>string</code></td><td>The signature that was extracted from the commit.</td></tr><tr><td><code>payload</code></td><td><code>string</code></td><td>The value that was signed.</td></tr></tbody></table>\n<p>These are the possible values for <code>reason</code> in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td><code>expired_key</code></td><td>The key that made the signature is expired.</td></tr><tr><td><code>not_signing_key</code></td><td>The \"signing\" flag is not among the usage flags in the GPG key that made the signature.</td></tr><tr><td><code>gpgverify_error</code></td><td>There was an error communicating with the signature verification service.</td></tr><tr><td><code>gpgverify_unavailable</code></td><td>The signature verification service is currently unavailable.</td></tr><tr><td><code>unsigned</code></td><td>The object does not include a signature.</td></tr><tr><td><code>unknown_signature_type</code></td><td>A non-PGP signature was found in the commit.</td></tr><tr><td><code>no_user</code></td><td>No user was associated with the <code>committer</code> email address in the commit.</td></tr><tr><td><code>unverified_email</code></td><td>The <code>committer</code> email address in the commit was associated with a user, but the email address is not verified on her/his account.</td></tr><tr><td><code>bad_email</code></td><td>The <code>committer</code> email address in the commit is not included in the identities of the PGP key that made the signature.</td></tr><tr><td><code>unknown_key</code></td><td>The key that made the signature has not been registered with any user's account.</td></tr><tr><td><code>malformed_signature</code></td><td>There was an error parsing the signature.</td></tr><tr><td><code>invalid</code></td><td>The signature could not be cryptographically verified using the key whose key-id was found in the signature.</td></tr><tr><td><code>valid</code></td><td>None of the above errors applied, so the signature is considered to be verified.</td></tr></tbody></table>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "201",
|
||||
@@ -33853,7 +33814,7 @@
|
||||
"subcategory": "commits",
|
||||
"notes": [],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Gets a Git <a href=\"https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects\">commit object</a>.</p>\n<p><strong>Signature verification object</strong></p>\n<p>The response will include a <code>verification</code> object that describes the result of verifying the commit's signature. The following fields are included in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>verified</code></td><td><code>boolean</code></td><td>Indicates whether GitHub considers the signature in this commit to be verified.</td></tr><tr><td><code>reason</code></td><td><code>string</code></td><td>The reason for verified value. Possible values and their meanings are enumerated in table below.</td></tr><tr><td><code>signature</code></td><td><code>string</code></td><td>The signature that was extracted from the commit.</td></tr><tr><td><code>payload</code></td><td><code>string</code></td><td>The value that was signed.</td></tr></tbody></table>\n<p>These are the possible values for <code>reason</code> in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td><code>expired_key</code></td><td>The key that made the signature is expired.</td></tr><tr><td><code>not_signing_key</code></td><td>The \"signing\" flag is not among the usage flags in the GPG key that made the signature.</td></tr><tr><td><code>gpgverify_error</code></td><td>There was an error communicating with the signature verification service.</td></tr><tr><td><code>gpgverify_unavailable</code></td><td>The signature verification service is currently unavailable.</td></tr><tr><td><code>unsigned</code></td><td>The object does not include a signature.</td></tr><tr><td><code>unknown_signature_type</code></td><td>A non-PGP signature was found in the commit.</td></tr><tr><td><code>no_user</code></td><td>No user was associated with the <code>committer</code> email address in the commit.</td></tr><tr><td><code>unverified_email</code></td><td>The <code>committer</code> email address in the commit was associated with a user, but the email address is not verified on her/his account.</td></tr><tr><td><code>bad_email</code></td><td>The <code>committer</code> email address in the commit is not included in the identities of the PGP key that made the signature.</td></tr><tr><td><code>unknown_key</code></td><td>The key that made the signature has not been registered with any user's account.</td></tr><tr><td><code>malformed_signature</code></td><td>There was an error parsing the signature.</td></tr><tr><td><code>invalid</code></td><td>The signature could not be cryptographically verified using the key whose key-id was found in the signature.</td></tr><tr><td><code>valid</code></td><td>None of the above errors applied, so the signature is considered to be verified.</td></tr></tbody></table>",
|
||||
"descriptionHTML": "<p>Gets a Git <a href=\"https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects\">commit object</a>.</p>\n<p><strong>Signature verification object</strong></p>\n<p>The response will include a <code>verification</code> object that describes the result of verifying the commit's signature. The following fields are included in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>verified</code></td><td><code>boolean</code></td><td>Indicates whether GitHub considers the signature in this commit to be verified.</td></tr><tr><td><code>reason</code></td><td><code>string</code></td><td>The reason for verified value. Possible values and their meanings are enumerated in the table below.</td></tr><tr><td><code>signature</code></td><td><code>string</code></td><td>The signature that was extracted from the commit.</td></tr><tr><td><code>payload</code></td><td><code>string</code></td><td>The value that was signed.</td></tr></tbody></table>\n<p>These are the possible values for <code>reason</code> in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td><code>expired_key</code></td><td>The key that made the signature is expired.</td></tr><tr><td><code>not_signing_key</code></td><td>The \"signing\" flag is not among the usage flags in the GPG key that made the signature.</td></tr><tr><td><code>gpgverify_error</code></td><td>There was an error communicating with the signature verification service.</td></tr><tr><td><code>gpgverify_unavailable</code></td><td>The signature verification service is currently unavailable.</td></tr><tr><td><code>unsigned</code></td><td>The object does not include a signature.</td></tr><tr><td><code>unknown_signature_type</code></td><td>A non-PGP signature was found in the commit.</td></tr><tr><td><code>no_user</code></td><td>No user was associated with the <code>committer</code> email address in the commit.</td></tr><tr><td><code>unverified_email</code></td><td>The <code>committer</code> email address in the commit was associated with a user, but the email address is not verified on her/his account.</td></tr><tr><td><code>bad_email</code></td><td>The <code>committer</code> email address in the commit is not included in the identities of the PGP key that made the signature.</td></tr><tr><td><code>unknown_key</code></td><td>The key that made the signature has not been registered with any user's account.</td></tr><tr><td><code>malformed_signature</code></td><td>There was an error parsing the signature.</td></tr><tr><td><code>invalid</code></td><td>The signature could not be cryptographically verified using the key whose key-id was found in the signature.</td></tr><tr><td><code>valid</code></td><td>None of the above errors applied, so the signature is considered to be verified.</td></tr></tbody></table>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
@@ -46971,11 +46932,6 @@
|
||||
"httpStatusMessage": "Forbidden",
|
||||
"description": "<p>Forbidden</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "415",
|
||||
"httpStatusMessage": "Unsupported Media Type",
|
||||
"description": "<p>Preview header missing</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "422",
|
||||
"httpStatusMessage": "Unprocessable Entity",
|
||||
@@ -50471,16 +50427,16 @@
|
||||
},
|
||||
"position": {
|
||||
"type": "integer",
|
||||
"description": "<p><strong>Required without <code>comfort-fade</code> preview unless using <code>in_reply_to</code></strong>. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.</p>",
|
||||
"description": "<p>The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.</p>",
|
||||
"name": "position",
|
||||
"in": "body",
|
||||
"rawType": "integer",
|
||||
"rawDescription": "**Required without `comfort-fade` preview unless using `in_reply_to`**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.",
|
||||
"rawDescription": "The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
"side": {
|
||||
"type": "string",
|
||||
"description": "<p><strong>Required with <code>comfort-fade</code> preview unless using <code>in_reply_to</code></strong>. In a split diff view, the side of the diff that the pull request's changes appear on. Can be <code>LEFT</code> or <code>RIGHT</code>. Use <code>LEFT</code> for deletions that appear in red. Use <code>RIGHT</code> for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"<a href=\"https://docs.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options\">Diff view options</a>\" in the GitHub Help documentation.</p>",
|
||||
"description": "<p>In a split diff view, the side of the diff that the pull request's changes appear on. Can be <code>LEFT</code> or <code>RIGHT</code>. Use <code>LEFT</code> for deletions that appear in red. Use <code>RIGHT</code> for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"<a href=\"https://docs.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options\">Diff view options</a>\" in the GitHub Help documentation.</p>",
|
||||
"enum": [
|
||||
"LEFT",
|
||||
"RIGHT"
|
||||
@@ -50488,30 +50444,30 @@
|
||||
"name": "side",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
"rawDescription": "**Required with `comfort-fade` preview unless using `in_reply_to`**. In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"[Diff view options](https://docs.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation.",
|
||||
"rawDescription": "In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"[Diff view options](https://docs.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
"line": {
|
||||
"type": "integer",
|
||||
"description": "<p><strong>Required with <code>comfort-fade</code> preview unless using <code>in_reply_to</code></strong>. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.</p>",
|
||||
"description": "<p>The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.</p>",
|
||||
"name": "line",
|
||||
"in": "body",
|
||||
"rawType": "integer",
|
||||
"rawDescription": "**Required with `comfort-fade` preview unless using `in_reply_to`**. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.",
|
||||
"rawDescription": "The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
"start_line": {
|
||||
"type": "integer",
|
||||
"description": "<p><strong>Required when using multi-line comments unless using <code>in_reply_to</code></strong>. To create multi-line comments, you must use the <code>comfort-fade</code> preview header. The <code>start_line</code> is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"<a href=\"https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request\">Commenting on a pull request</a>\" in the GitHub Help documentation.</p>",
|
||||
"description": "<p><strong>Required when using multi-line comments unless using <code>in_reply_to</code></strong>. The <code>start_line</code> is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"<a href=\"https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request\">Commenting on a pull request</a>\" in the GitHub Help documentation.</p>",
|
||||
"name": "start_line",
|
||||
"in": "body",
|
||||
"rawType": "integer",
|
||||
"rawDescription": "**Required when using multi-line comments unless using `in_reply_to`**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation.",
|
||||
"rawDescription": "**Required when using multi-line comments unless using `in_reply_to`**. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
"start_side": {
|
||||
"type": "string",
|
||||
"description": "<p><strong>Required when using multi-line comments unless using <code>in_reply_to</code></strong>. To create multi-line comments, you must use the <code>comfort-fade</code> preview header. The <code>start_side</code> is the starting side of the diff that the comment applies to. Can be <code>LEFT</code> or <code>RIGHT</code>. To learn more about multi-line comments, see \"<a href=\"https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request\">Commenting on a pull request</a>\" in the GitHub Help documentation. See <code>side</code> in this table for additional context.</p>",
|
||||
"description": "<p><strong>Required when using multi-line comments unless using <code>in_reply_to</code></strong>. The <code>start_side</code> is the starting side of the diff that the comment applies to. Can be <code>LEFT</code> or <code>RIGHT</code>. To learn more about multi-line comments, see \"<a href=\"https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request\">Commenting on a pull request</a>\" in the GitHub Help documentation. See <code>side</code> in this table for additional context.</p>",
|
||||
"enum": [
|
||||
"LEFT",
|
||||
"RIGHT",
|
||||
@@ -50520,7 +50476,7 @@
|
||||
"name": "start_side",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
"rawDescription": "**Required when using multi-line comments unless using `in_reply_to`**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.",
|
||||
"rawDescription": "**Required when using multi-line comments unless using `in_reply_to`**. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
"in_reply_to": {
|
||||
@@ -50616,16 +50572,16 @@
|
||||
},
|
||||
{
|
||||
"type": "integer",
|
||||
"description": "<p><strong>Required without <code>comfort-fade</code> preview unless using <code>in_reply_to</code></strong>. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.</p>",
|
||||
"description": "<p>The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.</p>",
|
||||
"name": "position",
|
||||
"in": "body",
|
||||
"rawType": "integer",
|
||||
"rawDescription": "**Required without `comfort-fade` preview unless using `in_reply_to`**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.",
|
||||
"rawDescription": "The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"description": "<p><strong>Required with <code>comfort-fade</code> preview unless using <code>in_reply_to</code></strong>. In a split diff view, the side of the diff that the pull request's changes appear on. Can be <code>LEFT</code> or <code>RIGHT</code>. Use <code>LEFT</code> for deletions that appear in red. Use <code>RIGHT</code> for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"<a href=\"https://docs.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options\">Diff view options</a>\" in the GitHub Help documentation.</p>",
|
||||
"description": "<p>In a split diff view, the side of the diff that the pull request's changes appear on. Can be <code>LEFT</code> or <code>RIGHT</code>. Use <code>LEFT</code> for deletions that appear in red. Use <code>RIGHT</code> for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"<a href=\"https://docs.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options\">Diff view options</a>\" in the GitHub Help documentation.</p>",
|
||||
"enum": [
|
||||
"LEFT",
|
||||
"RIGHT"
|
||||
@@ -50633,30 +50589,30 @@
|
||||
"name": "side",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
"rawDescription": "**Required with `comfort-fade` preview unless using `in_reply_to`**. In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"[Diff view options](https://docs.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation.",
|
||||
"rawDescription": "In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"[Diff view options](https://docs.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"type": "integer",
|
||||
"description": "<p><strong>Required with <code>comfort-fade</code> preview unless using <code>in_reply_to</code></strong>. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.</p>",
|
||||
"description": "<p>The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.</p>",
|
||||
"name": "line",
|
||||
"in": "body",
|
||||
"rawType": "integer",
|
||||
"rawDescription": "**Required with `comfort-fade` preview unless using `in_reply_to`**. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.",
|
||||
"rawDescription": "The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"type": "integer",
|
||||
"description": "<p><strong>Required when using multi-line comments unless using <code>in_reply_to</code></strong>. To create multi-line comments, you must use the <code>comfort-fade</code> preview header. The <code>start_line</code> is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"<a href=\"https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request\">Commenting on a pull request</a>\" in the GitHub Help documentation.</p>",
|
||||
"description": "<p><strong>Required when using multi-line comments unless using <code>in_reply_to</code></strong>. The <code>start_line</code> is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"<a href=\"https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request\">Commenting on a pull request</a>\" in the GitHub Help documentation.</p>",
|
||||
"name": "start_line",
|
||||
"in": "body",
|
||||
"rawType": "integer",
|
||||
"rawDescription": "**Required when using multi-line comments unless using `in_reply_to`**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation.",
|
||||
"rawDescription": "**Required when using multi-line comments unless using `in_reply_to`**. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"description": "<p><strong>Required when using multi-line comments unless using <code>in_reply_to</code></strong>. To create multi-line comments, you must use the <code>comfort-fade</code> preview header. The <code>start_side</code> is the starting side of the diff that the comment applies to. Can be <code>LEFT</code> or <code>RIGHT</code>. To learn more about multi-line comments, see \"<a href=\"https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request\">Commenting on a pull request</a>\" in the GitHub Help documentation. See <code>side</code> in this table for additional context.</p>",
|
||||
"description": "<p><strong>Required when using multi-line comments unless using <code>in_reply_to</code></strong>. The <code>start_side</code> is the starting side of the diff that the comment applies to. Can be <code>LEFT</code> or <code>RIGHT</code>. To learn more about multi-line comments, see \"<a href=\"https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request\">Commenting on a pull request</a>\" in the GitHub Help documentation. See <code>side</code> in this table for additional context.</p>",
|
||||
"enum": [
|
||||
"LEFT",
|
||||
"RIGHT",
|
||||
@@ -50665,7 +50621,7 @@
|
||||
"name": "start_side",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
"rawDescription": "**Required when using multi-line comments unless using `in_reply_to`**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.",
|
||||
"rawDescription": "**Required when using multi-line comments unless using `in_reply_to`**. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
@@ -55642,11 +55598,6 @@
|
||||
"httpStatusCode": "404",
|
||||
"httpStatusMessage": "Not Found",
|
||||
"description": "<p>Resource not found</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "415",
|
||||
"httpStatusMessage": "Unsupported Media Type",
|
||||
"description": "<p>Preview header missing</p>"
|
||||
}
|
||||
]
|
||||
},
|
||||
@@ -56756,7 +56707,7 @@
|
||||
},
|
||||
"visibility": {
|
||||
"type": "string",
|
||||
"description": "<p>Can be <code>public</code> or <code>private</code>. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, <code>visibility</code> can also be <code>internal</code>. The <code>visibility</code> parameter overrides the <code>private</code> parameter when you use both along with the <code>nebula-preview</code> preview header.</p>",
|
||||
"description": "<p>Can be <code>public</code> or <code>private</code>. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, <code>visibility</code> can also be <code>internal</code>.\"</p>",
|
||||
"enum": [
|
||||
"public",
|
||||
"private",
|
||||
@@ -56765,7 +56716,7 @@
|
||||
"name": "visibility",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
"rawDescription": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. The `visibility` parameter overrides the `private` parameter when you use both along with the `nebula-preview` preview header.",
|
||||
"rawDescription": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`.\"",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
"security_and_analysis": {
|
||||
@@ -56794,7 +56745,7 @@
|
||||
},
|
||||
"secret_scanning_push_protection": {
|
||||
"type": "object",
|
||||
"description": "Use the `status` property to enable or disable secret scanning push protection for this repository. For more information, see \"[About push protection](/enterprise-cloud@latest/early-access/code-security/secret-scanning/protecting-pushes-with-secret-scanning).\"",
|
||||
"description": "Use the `status` property to enable or disable secret scanning push protection for this repository. For more information, see \"[Protecting pushes with secret scanning](/enterprise-cloud@latest/code-security/secret-scanning/protecting-pushes-with-secret-scanning).\"",
|
||||
"properties": {
|
||||
"status": {
|
||||
"type": "string",
|
||||
@@ -57022,7 +56973,7 @@
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"description": "<p>Can be <code>public</code> or <code>private</code>. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, <code>visibility</code> can also be <code>internal</code>. The <code>visibility</code> parameter overrides the <code>private</code> parameter when you use both along with the <code>nebula-preview</code> preview header.</p>",
|
||||
"description": "<p>Can be <code>public</code> or <code>private</code>. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, <code>visibility</code> can also be <code>internal</code>.\"</p>",
|
||||
"enum": [
|
||||
"public",
|
||||
"private",
|
||||
@@ -57031,7 +56982,7 @@
|
||||
"name": "visibility",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
"rawDescription": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. The `visibility` parameter overrides the `private` parameter when you use both along with the `nebula-preview` preview header.",
|
||||
"rawDescription": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`.\"",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
@@ -57060,7 +57011,7 @@
|
||||
},
|
||||
"secret_scanning_push_protection": {
|
||||
"type": "object",
|
||||
"description": "Use the `status` property to enable or disable secret scanning push protection for this repository. For more information, see \"[About push protection](/enterprise-cloud@latest/early-access/code-security/secret-scanning/protecting-pushes-with-secret-scanning).\"",
|
||||
"description": "Use the `status` property to enable or disable secret scanning push protection for this repository. For more information, see \"[Protecting pushes with secret scanning](/enterprise-cloud@latest/code-security/secret-scanning/protecting-pushes-with-secret-scanning).\"",
|
||||
"properties": {
|
||||
"status": {
|
||||
"type": "string",
|
||||
@@ -64118,11 +64069,6 @@
|
||||
"httpStatusMessage": "Not Found",
|
||||
"description": "<p>Resource not found</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "415",
|
||||
"httpStatusMessage": "Unsupported Media Type",
|
||||
"description": "<p>Preview header missing</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "422",
|
||||
"httpStatusMessage": "Unprocessable Entity",
|
||||
|
||||
Reference in New Issue
Block a user