From a45a14f4d225ab8012f6866c9dcf23257b532bb9 Mon Sep 17 00:00:00 2001 From: github-openapi-bot <69533958+github-openapi-bot@users.noreply.github.com> Date: Thu, 18 Nov 2021 06:06:42 -0500 Subject: [PATCH] Update OpenAPI Descriptions --- lib/rest/static/decorated/api.github.com.json | 290 +++++++++++++++++- lib/rest/static/decorated/ghes-3.0.json | 290 +++++++++++++++++- lib/rest/static/decorated/ghes-3.1.json | 290 +++++++++++++++++- lib/rest/static/decorated/ghes-3.2.json | 290 +++++++++++++++++- lib/rest/static/decorated/ghes-3.3.json | 290 +++++++++++++++++- lib/rest/static/decorated/github.ae.json | 290 +++++++++++++++++- .../dereferenced/api.github.com.deref.json | 141 +++++++++ .../static/dereferenced/ghes-3.0.deref.json | 122 ++++++++ .../static/dereferenced/ghes-3.1.deref.json | 141 +++++++++ .../static/dereferenced/ghes-3.2.deref.json | 141 +++++++++ .../static/dereferenced/ghes-3.3.deref.json | 141 +++++++++ .../static/dereferenced/github.ae.deref.json | 122 ++++++++ 12 files changed, 2524 insertions(+), 24 deletions(-) diff --git a/lib/rest/static/decorated/api.github.com.json b/lib/rest/static/decorated/api.github.com.json index 5d85ff2a50fe..fa38d8fd9039 100644 --- a/lib/rest/static/decorated/api.github.com.json +++ b/lib/rest/static/decorated/api.github.com.json @@ -38237,13 +38237,13 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection \\\n -d '{\"required_status_checks\":{\"strict\":true,\"contexts\":[\"contexts\"]},\"enforce_admins\":true,\"required_pull_request_reviews\":{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":42},\"restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"],\"apps\":[\"apps\"]}}'", - "html": "
curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection \\\n  -d '{\"required_status_checks\":{\"strict\":true,\"contexts\":[\"contexts\"]},\"enforce_admins\":true,\"required_pull_request_reviews\":{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":42},\"restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"],\"apps\":[\"apps\"]}}'
" + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection \\\n -d '{\"required_status_checks\":{\"strict\":true,\"contexts\":[\"contexts\"],\"checks\":[{\"context\":\"context\",\"app_id\":\"app_id\"}]},\"enforce_admins\":true,\"required_pull_request_reviews\":{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":42},\"restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"],\"apps\":[\"apps\"]}}'", + "html": "
curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection \\\n  -d '{\"required_status_checks\":{\"strict\":true,\"contexts\":[\"contexts\"],\"checks\":[{\"context\":\"context\",\"app_id\":\"app_id\"}]},\"enforce_admins\":true,\"required_pull_request_reviews\":{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":42},\"restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"],\"apps\":[\"apps\"]}}'
" }, { "lang": "JavaScript", - "source": "await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch',\n required_status_checks: {\n strict: true,\n contexts: [\n 'contexts'\n ]\n },\n enforce_admins: true,\n required_pull_request_reviews: {\n dismissal_restrictions: {\n users: [\n 'users'\n ],\n teams: [\n 'teams'\n ]\n },\n dismiss_stale_reviews: true,\n require_code_owner_reviews: true,\n required_approving_review_count: 42\n },\n restrictions: {\n users: [\n 'users'\n ],\n teams: [\n 'teams'\n ],\n apps: [\n 'apps'\n ]\n }\n})", - "html": "
await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch',\n  required_status_checks: {\n    strict: true,\n    contexts: [\n      'contexts'\n    ]\n  },\n  enforce_admins: true,\n  required_pull_request_reviews: {\n    dismissal_restrictions: {\n      users: [\n        'users'\n      ],\n      teams: [\n        'teams'\n      ]\n    },\n    dismiss_stale_reviews: true,\n    require_code_owner_reviews: true,\n    required_approving_review_count: 42\n  },\n  restrictions: {\n    users: [\n      'users'\n    ],\n    teams: [\n      'teams'\n    ],\n    apps: [\n      'apps'\n    ]\n  }\n})\n
" + "source": "await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch',\n required_status_checks: {\n strict: true,\n contexts: [\n 'contexts'\n ],\n checks: [\n {\n context: 'context',\n app_id: 'app_id'\n }\n ]\n },\n enforce_admins: true,\n required_pull_request_reviews: {\n dismissal_restrictions: {\n users: [\n 'users'\n ],\n teams: [\n 'teams'\n ]\n },\n dismiss_stale_reviews: true,\n require_code_owner_reviews: true,\n required_approving_review_count: 42\n },\n restrictions: {\n users: [\n 'users'\n ],\n teams: [\n 'teams'\n ],\n apps: [\n 'apps'\n ]\n }\n})", + "html": "
await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch',\n  required_status_checks: {\n    strict: true,\n    contexts: [\n      'contexts'\n    ],\n    checks: [\n      {\n        context: 'context',\n        app_id: 'app_id'\n      }\n    ]\n  },\n  enforce_admins: true,\n  required_pull_request_reviews: {\n    dismissal_restrictions: {\n      users: [\n        'users'\n      ],\n      teams: [\n        'teams'\n      ]\n    },\n    dismiss_stale_reviews: true,\n    require_code_owner_reviews: true,\n    required_approving_review_count: 42\n  },\n  restrictions: {\n    users: [\n      'users'\n    ],\n    teams: [\n      'teams'\n    ],\n    apps: [\n      'apps'\n    ]\n  }\n})\n
" } ], "summary": "Update branch protection", @@ -38288,6 +38288,64 @@ "rawType": "array", "rawDescription": "The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.", "childParamsGroups": [] + }, + "checks": { + "type": "array of objects", + "description": "

The list of status checks to require in order to merge into this branch.

", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string", + "description": "

The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + "app_id": { + "type": "string", + "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "name": "app_id", + "in": "body", + "rawType": "string", + "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "childParamsGroups": [] + } + } + }, + "name": "checks", + "in": "body", + "rawType": "array", + "rawDescription": "The list of status checks to require in order to merge into this branch.", + "childParamsGroups": [ + { + "parentName": "checks", + "parentType": "items", + "id": "checks-items", + "params": [ + { + "type": "string", + "description": "

The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "name": "app_id", + "in": "body", + "rawType": "string", + "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "childParamsGroups": [] + } + ] + } + ] } }, "required": [ @@ -38324,6 +38382,89 @@ "rawType": "array", "rawDescription": "The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.", "childParamsGroups": [] + }, + { + "type": "array of objects", + "description": "

The list of status checks to require in order to merge into this branch.

", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string", + "description": "

The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + "app_id": { + "type": "string", + "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "name": "app_id", + "in": "body", + "rawType": "string", + "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "childParamsGroups": [] + } + } + }, + "name": "checks", + "in": "body", + "rawType": "array", + "rawDescription": "The list of status checks to require in order to merge into this branch.", + "childParamsGroups": [ + { + "parentName": "checks", + "parentType": "items", + "id": "checks-items", + "params": [ + { + "type": "string", + "description": "

The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "name": "app_id", + "in": "body", + "rawType": "string", + "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "childParamsGroups": [] + } + ] + } + ] + } + ] + }, + { + "parentName": "checks", + "parentType": "items", + "id": "checks-items", + "params": [ + { + "type": "string", + "description": "

The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "name": "app_id", + "in": "body", + "rawType": "string", + "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "childParamsGroups": [] } ] } @@ -38821,6 +38962,64 @@ "rawType": "array", "rawDescription": "The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.", "childParamsGroups": [] + }, + "checks": { + "type": "array of objects", + "description": "

The list of status checks to require in order to merge into this branch.

", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string", + "description": "

The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + "app_id": { + "type": "string", + "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "name": "app_id", + "in": "body", + "rawType": "string", + "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "childParamsGroups": [] + } + } + }, + "name": "checks", + "in": "body", + "rawType": "array", + "rawDescription": "The list of status checks to require in order to merge into this branch.", + "childParamsGroups": [ + { + "parentName": "checks", + "parentType": "items", + "id": "checks-items", + "params": [ + { + "type": "string", + "description": "

The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "name": "app_id", + "in": "body", + "rawType": "string", + "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "childParamsGroups": [] + } + ] + } + ] } }, "required": [ @@ -38857,6 +39056,89 @@ "rawType": "array", "rawDescription": "The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.", "childParamsGroups": [] + }, + { + "type": "array of objects", + "description": "

The list of status checks to require in order to merge into this branch.

", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string", + "description": "

The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + "app_id": { + "type": "string", + "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "name": "app_id", + "in": "body", + "rawType": "string", + "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "childParamsGroups": [] + } + } + }, + "name": "checks", + "in": "body", + "rawType": "array", + "rawDescription": "The list of status checks to require in order to merge into this branch.", + "childParamsGroups": [ + { + "parentName": "checks", + "parentType": "items", + "id": "checks-items", + "params": [ + { + "type": "string", + "description": "

The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "name": "app_id", + "in": "body", + "rawType": "string", + "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "childParamsGroups": [] + } + ] + } + ] + } + ] + }, + { + "parentName": "checks", + "parentType": "items", + "id": "checks-items", + "params": [ + { + "type": "string", + "description": "

The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "name": "app_id", + "in": "body", + "rawType": "string", + "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "childParamsGroups": [] } ] } diff --git a/lib/rest/static/decorated/ghes-3.0.json b/lib/rest/static/decorated/ghes-3.0.json index 487e1ff20eac..0d2fefa14959 100644 --- a/lib/rest/static/decorated/ghes-3.0.json +++ b/lib/rest/static/decorated/ghes-3.0.json @@ -36135,13 +36135,13 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection \\\n -d '{\"required_status_checks\":{\"strict\":true,\"contexts\":[\"contexts\"]},\"enforce_admins\":true,\"required_pull_request_reviews\":{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":42},\"restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"],\"apps\":[\"apps\"]}}'", - "html": "
curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection \\\n  -d '{\"required_status_checks\":{\"strict\":true,\"contexts\":[\"contexts\"]},\"enforce_admins\":true,\"required_pull_request_reviews\":{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":42},\"restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"],\"apps\":[\"apps\"]}}'
" + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection \\\n -d '{\"required_status_checks\":{\"strict\":true,\"contexts\":[\"contexts\"],\"checks\":[{\"context\":\"context\",\"app_id\":\"app_id\"}]},\"enforce_admins\":true,\"required_pull_request_reviews\":{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":42},\"restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"],\"apps\":[\"apps\"]}}'", + "html": "
curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection \\\n  -d '{\"required_status_checks\":{\"strict\":true,\"contexts\":[\"contexts\"],\"checks\":[{\"context\":\"context\",\"app_id\":\"app_id\"}]},\"enforce_admins\":true,\"required_pull_request_reviews\":{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":42},\"restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"],\"apps\":[\"apps\"]}}'
" }, { "lang": "JavaScript", - "source": "await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch',\n required_status_checks: {\n strict: true,\n contexts: [\n 'contexts'\n ]\n },\n enforce_admins: true,\n required_pull_request_reviews: {\n dismissal_restrictions: {\n users: [\n 'users'\n ],\n teams: [\n 'teams'\n ]\n },\n dismiss_stale_reviews: true,\n require_code_owner_reviews: true,\n required_approving_review_count: 42\n },\n restrictions: {\n users: [\n 'users'\n ],\n teams: [\n 'teams'\n ],\n apps: [\n 'apps'\n ]\n }\n})", - "html": "
await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch',\n  required_status_checks: {\n    strict: true,\n    contexts: [\n      'contexts'\n    ]\n  },\n  enforce_admins: true,\n  required_pull_request_reviews: {\n    dismissal_restrictions: {\n      users: [\n        'users'\n      ],\n      teams: [\n        'teams'\n      ]\n    },\n    dismiss_stale_reviews: true,\n    require_code_owner_reviews: true,\n    required_approving_review_count: 42\n  },\n  restrictions: {\n    users: [\n      'users'\n    ],\n    teams: [\n      'teams'\n    ],\n    apps: [\n      'apps'\n    ]\n  }\n})\n
" + "source": "await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch',\n required_status_checks: {\n strict: true,\n contexts: [\n 'contexts'\n ],\n checks: [\n {\n context: 'context',\n app_id: 'app_id'\n }\n ]\n },\n enforce_admins: true,\n required_pull_request_reviews: {\n dismissal_restrictions: {\n users: [\n 'users'\n ],\n teams: [\n 'teams'\n ]\n },\n dismiss_stale_reviews: true,\n require_code_owner_reviews: true,\n required_approving_review_count: 42\n },\n restrictions: {\n users: [\n 'users'\n ],\n teams: [\n 'teams'\n ],\n apps: [\n 'apps'\n ]\n }\n})", + "html": "
await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch',\n  required_status_checks: {\n    strict: true,\n    contexts: [\n      'contexts'\n    ],\n    checks: [\n      {\n        context: 'context',\n        app_id: 'app_id'\n      }\n    ]\n  },\n  enforce_admins: true,\n  required_pull_request_reviews: {\n    dismissal_restrictions: {\n      users: [\n        'users'\n      ],\n      teams: [\n        'teams'\n      ]\n    },\n    dismiss_stale_reviews: true,\n    require_code_owner_reviews: true,\n    required_approving_review_count: 42\n  },\n  restrictions: {\n    users: [\n      'users'\n    ],\n    teams: [\n      'teams'\n    ],\n    apps: [\n      'apps'\n    ]\n  }\n})\n
" } ], "summary": "Update branch protection", @@ -36186,6 +36186,64 @@ "rawType": "array", "rawDescription": "The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.", "childParamsGroups": [] + }, + "checks": { + "type": "array of objects", + "description": "

The list of status checks to require in order to merge into this branch.

", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string", + "description": "

The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + "app_id": { + "type": "string", + "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "name": "app_id", + "in": "body", + "rawType": "string", + "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "childParamsGroups": [] + } + } + }, + "name": "checks", + "in": "body", + "rawType": "array", + "rawDescription": "The list of status checks to require in order to merge into this branch.", + "childParamsGroups": [ + { + "parentName": "checks", + "parentType": "items", + "id": "checks-items", + "params": [ + { + "type": "string", + "description": "

The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "name": "app_id", + "in": "body", + "rawType": "string", + "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "childParamsGroups": [] + } + ] + } + ] } }, "required": [ @@ -36222,6 +36280,89 @@ "rawType": "array", "rawDescription": "The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.", "childParamsGroups": [] + }, + { + "type": "array of objects", + "description": "

The list of status checks to require in order to merge into this branch.

", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string", + "description": "

The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + "app_id": { + "type": "string", + "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "name": "app_id", + "in": "body", + "rawType": "string", + "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "childParamsGroups": [] + } + } + }, + "name": "checks", + "in": "body", + "rawType": "array", + "rawDescription": "The list of status checks to require in order to merge into this branch.", + "childParamsGroups": [ + { + "parentName": "checks", + "parentType": "items", + "id": "checks-items", + "params": [ + { + "type": "string", + "description": "

The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "name": "app_id", + "in": "body", + "rawType": "string", + "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "childParamsGroups": [] + } + ] + } + ] + } + ] + }, + { + "parentName": "checks", + "parentType": "items", + "id": "checks-items", + "params": [ + { + "type": "string", + "description": "

The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "name": "app_id", + "in": "body", + "rawType": "string", + "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "childParamsGroups": [] } ] } @@ -36727,6 +36868,64 @@ "rawType": "array", "rawDescription": "The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.", "childParamsGroups": [] + }, + "checks": { + "type": "array of objects", + "description": "

The list of status checks to require in order to merge into this branch.

", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string", + "description": "

The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + "app_id": { + "type": "string", + "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "name": "app_id", + "in": "body", + "rawType": "string", + "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "childParamsGroups": [] + } + } + }, + "name": "checks", + "in": "body", + "rawType": "array", + "rawDescription": "The list of status checks to require in order to merge into this branch.", + "childParamsGroups": [ + { + "parentName": "checks", + "parentType": "items", + "id": "checks-items", + "params": [ + { + "type": "string", + "description": "

The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "name": "app_id", + "in": "body", + "rawType": "string", + "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "childParamsGroups": [] + } + ] + } + ] } }, "required": [ @@ -36763,6 +36962,89 @@ "rawType": "array", "rawDescription": "The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.", "childParamsGroups": [] + }, + { + "type": "array of objects", + "description": "

The list of status checks to require in order to merge into this branch.

", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string", + "description": "

The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + "app_id": { + "type": "string", + "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "name": "app_id", + "in": "body", + "rawType": "string", + "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "childParamsGroups": [] + } + } + }, + "name": "checks", + "in": "body", + "rawType": "array", + "rawDescription": "The list of status checks to require in order to merge into this branch.", + "childParamsGroups": [ + { + "parentName": "checks", + "parentType": "items", + "id": "checks-items", + "params": [ + { + "type": "string", + "description": "

The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "name": "app_id", + "in": "body", + "rawType": "string", + "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "childParamsGroups": [] + } + ] + } + ] + } + ] + }, + { + "parentName": "checks", + "parentType": "items", + "id": "checks-items", + "params": [ + { + "type": "string", + "description": "

The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "name": "app_id", + "in": "body", + "rawType": "string", + "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "childParamsGroups": [] } ] } diff --git a/lib/rest/static/decorated/ghes-3.1.json b/lib/rest/static/decorated/ghes-3.1.json index 9e6bfd25d427..14f69ee89ede 100644 --- a/lib/rest/static/decorated/ghes-3.1.json +++ b/lib/rest/static/decorated/ghes-3.1.json @@ -36257,13 +36257,13 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection \\\n -d '{\"required_status_checks\":{\"strict\":true,\"contexts\":[\"contexts\"]},\"enforce_admins\":true,\"required_pull_request_reviews\":{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":42},\"restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"],\"apps\":[\"apps\"]}}'", - "html": "
curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection \\\n  -d '{\"required_status_checks\":{\"strict\":true,\"contexts\":[\"contexts\"]},\"enforce_admins\":true,\"required_pull_request_reviews\":{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":42},\"restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"],\"apps\":[\"apps\"]}}'
" + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection \\\n -d '{\"required_status_checks\":{\"strict\":true,\"contexts\":[\"contexts\"],\"checks\":[{\"context\":\"context\",\"app_id\":\"app_id\"}]},\"enforce_admins\":true,\"required_pull_request_reviews\":{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":42},\"restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"],\"apps\":[\"apps\"]}}'", + "html": "
curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection \\\n  -d '{\"required_status_checks\":{\"strict\":true,\"contexts\":[\"contexts\"],\"checks\":[{\"context\":\"context\",\"app_id\":\"app_id\"}]},\"enforce_admins\":true,\"required_pull_request_reviews\":{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":42},\"restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"],\"apps\":[\"apps\"]}}'
" }, { "lang": "JavaScript", - "source": "await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch',\n required_status_checks: {\n strict: true,\n contexts: [\n 'contexts'\n ]\n },\n enforce_admins: true,\n required_pull_request_reviews: {\n dismissal_restrictions: {\n users: [\n 'users'\n ],\n teams: [\n 'teams'\n ]\n },\n dismiss_stale_reviews: true,\n require_code_owner_reviews: true,\n required_approving_review_count: 42\n },\n restrictions: {\n users: [\n 'users'\n ],\n teams: [\n 'teams'\n ],\n apps: [\n 'apps'\n ]\n }\n})", - "html": "
await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch',\n  required_status_checks: {\n    strict: true,\n    contexts: [\n      'contexts'\n    ]\n  },\n  enforce_admins: true,\n  required_pull_request_reviews: {\n    dismissal_restrictions: {\n      users: [\n        'users'\n      ],\n      teams: [\n        'teams'\n      ]\n    },\n    dismiss_stale_reviews: true,\n    require_code_owner_reviews: true,\n    required_approving_review_count: 42\n  },\n  restrictions: {\n    users: [\n      'users'\n    ],\n    teams: [\n      'teams'\n    ],\n    apps: [\n      'apps'\n    ]\n  }\n})\n
" + "source": "await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch',\n required_status_checks: {\n strict: true,\n contexts: [\n 'contexts'\n ],\n checks: [\n {\n context: 'context',\n app_id: 'app_id'\n }\n ]\n },\n enforce_admins: true,\n required_pull_request_reviews: {\n dismissal_restrictions: {\n users: [\n 'users'\n ],\n teams: [\n 'teams'\n ]\n },\n dismiss_stale_reviews: true,\n require_code_owner_reviews: true,\n required_approving_review_count: 42\n },\n restrictions: {\n users: [\n 'users'\n ],\n teams: [\n 'teams'\n ],\n apps: [\n 'apps'\n ]\n }\n})", + "html": "
await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch',\n  required_status_checks: {\n    strict: true,\n    contexts: [\n      'contexts'\n    ],\n    checks: [\n      {\n        context: 'context',\n        app_id: 'app_id'\n      }\n    ]\n  },\n  enforce_admins: true,\n  required_pull_request_reviews: {\n    dismissal_restrictions: {\n      users: [\n        'users'\n      ],\n      teams: [\n        'teams'\n      ]\n    },\n    dismiss_stale_reviews: true,\n    require_code_owner_reviews: true,\n    required_approving_review_count: 42\n  },\n  restrictions: {\n    users: [\n      'users'\n    ],\n    teams: [\n      'teams'\n    ],\n    apps: [\n      'apps'\n    ]\n  }\n})\n
" } ], "summary": "Update branch protection", @@ -36308,6 +36308,64 @@ "rawType": "array", "rawDescription": "The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.", "childParamsGroups": [] + }, + "checks": { + "type": "array of objects", + "description": "

The list of status checks to require in order to merge into this branch.

", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string", + "description": "

The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + "app_id": { + "type": "string", + "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "name": "app_id", + "in": "body", + "rawType": "string", + "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "childParamsGroups": [] + } + } + }, + "name": "checks", + "in": "body", + "rawType": "array", + "rawDescription": "The list of status checks to require in order to merge into this branch.", + "childParamsGroups": [ + { + "parentName": "checks", + "parentType": "items", + "id": "checks-items", + "params": [ + { + "type": "string", + "description": "

The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "name": "app_id", + "in": "body", + "rawType": "string", + "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "childParamsGroups": [] + } + ] + } + ] } }, "required": [ @@ -36344,6 +36402,89 @@ "rawType": "array", "rawDescription": "The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.", "childParamsGroups": [] + }, + { + "type": "array of objects", + "description": "

The list of status checks to require in order to merge into this branch.

", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string", + "description": "

The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + "app_id": { + "type": "string", + "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "name": "app_id", + "in": "body", + "rawType": "string", + "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "childParamsGroups": [] + } + } + }, + "name": "checks", + "in": "body", + "rawType": "array", + "rawDescription": "The list of status checks to require in order to merge into this branch.", + "childParamsGroups": [ + { + "parentName": "checks", + "parentType": "items", + "id": "checks-items", + "params": [ + { + "type": "string", + "description": "

The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "name": "app_id", + "in": "body", + "rawType": "string", + "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "childParamsGroups": [] + } + ] + } + ] + } + ] + }, + { + "parentName": "checks", + "parentType": "items", + "id": "checks-items", + "params": [ + { + "type": "string", + "description": "

The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "name": "app_id", + "in": "body", + "rawType": "string", + "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "childParamsGroups": [] } ] } @@ -36849,6 +36990,64 @@ "rawType": "array", "rawDescription": "The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.", "childParamsGroups": [] + }, + "checks": { + "type": "array of objects", + "description": "

The list of status checks to require in order to merge into this branch.

", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string", + "description": "

The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + "app_id": { + "type": "string", + "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "name": "app_id", + "in": "body", + "rawType": "string", + "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "childParamsGroups": [] + } + } + }, + "name": "checks", + "in": "body", + "rawType": "array", + "rawDescription": "The list of status checks to require in order to merge into this branch.", + "childParamsGroups": [ + { + "parentName": "checks", + "parentType": "items", + "id": "checks-items", + "params": [ + { + "type": "string", + "description": "

The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "name": "app_id", + "in": "body", + "rawType": "string", + "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "childParamsGroups": [] + } + ] + } + ] } }, "required": [ @@ -36885,6 +37084,89 @@ "rawType": "array", "rawDescription": "The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.", "childParamsGroups": [] + }, + { + "type": "array of objects", + "description": "

The list of status checks to require in order to merge into this branch.

", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string", + "description": "

The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + "app_id": { + "type": "string", + "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "name": "app_id", + "in": "body", + "rawType": "string", + "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "childParamsGroups": [] + } + } + }, + "name": "checks", + "in": "body", + "rawType": "array", + "rawDescription": "The list of status checks to require in order to merge into this branch.", + "childParamsGroups": [ + { + "parentName": "checks", + "parentType": "items", + "id": "checks-items", + "params": [ + { + "type": "string", + "description": "

The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "name": "app_id", + "in": "body", + "rawType": "string", + "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "childParamsGroups": [] + } + ] + } + ] + } + ] + }, + { + "parentName": "checks", + "parentType": "items", + "id": "checks-items", + "params": [ + { + "type": "string", + "description": "

The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "name": "app_id", + "in": "body", + "rawType": "string", + "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "childParamsGroups": [] } ] } diff --git a/lib/rest/static/decorated/ghes-3.2.json b/lib/rest/static/decorated/ghes-3.2.json index 365c4fa94225..27f083dec678 100644 --- a/lib/rest/static/decorated/ghes-3.2.json +++ b/lib/rest/static/decorated/ghes-3.2.json @@ -37503,13 +37503,13 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection \\\n -d '{\"required_status_checks\":{\"strict\":true,\"contexts\":[\"contexts\"]},\"enforce_admins\":true,\"required_pull_request_reviews\":{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":42},\"restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"],\"apps\":[\"apps\"]}}'", - "html": "
curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection \\\n  -d '{\"required_status_checks\":{\"strict\":true,\"contexts\":[\"contexts\"]},\"enforce_admins\":true,\"required_pull_request_reviews\":{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":42},\"restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"],\"apps\":[\"apps\"]}}'
" + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection \\\n -d '{\"required_status_checks\":{\"strict\":true,\"contexts\":[\"contexts\"],\"checks\":[{\"context\":\"context\",\"app_id\":\"app_id\"}]},\"enforce_admins\":true,\"required_pull_request_reviews\":{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":42},\"restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"],\"apps\":[\"apps\"]}}'", + "html": "
curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection \\\n  -d '{\"required_status_checks\":{\"strict\":true,\"contexts\":[\"contexts\"],\"checks\":[{\"context\":\"context\",\"app_id\":\"app_id\"}]},\"enforce_admins\":true,\"required_pull_request_reviews\":{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":42},\"restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"],\"apps\":[\"apps\"]}}'
" }, { "lang": "JavaScript", - "source": "await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch',\n required_status_checks: {\n strict: true,\n contexts: [\n 'contexts'\n ]\n },\n enforce_admins: true,\n required_pull_request_reviews: {\n dismissal_restrictions: {\n users: [\n 'users'\n ],\n teams: [\n 'teams'\n ]\n },\n dismiss_stale_reviews: true,\n require_code_owner_reviews: true,\n required_approving_review_count: 42\n },\n restrictions: {\n users: [\n 'users'\n ],\n teams: [\n 'teams'\n ],\n apps: [\n 'apps'\n ]\n }\n})", - "html": "
await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch',\n  required_status_checks: {\n    strict: true,\n    contexts: [\n      'contexts'\n    ]\n  },\n  enforce_admins: true,\n  required_pull_request_reviews: {\n    dismissal_restrictions: {\n      users: [\n        'users'\n      ],\n      teams: [\n        'teams'\n      ]\n    },\n    dismiss_stale_reviews: true,\n    require_code_owner_reviews: true,\n    required_approving_review_count: 42\n  },\n  restrictions: {\n    users: [\n      'users'\n    ],\n    teams: [\n      'teams'\n    ],\n    apps: [\n      'apps'\n    ]\n  }\n})\n
" + "source": "await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch',\n required_status_checks: {\n strict: true,\n contexts: [\n 'contexts'\n ],\n checks: [\n {\n context: 'context',\n app_id: 'app_id'\n }\n ]\n },\n enforce_admins: true,\n required_pull_request_reviews: {\n dismissal_restrictions: {\n users: [\n 'users'\n ],\n teams: [\n 'teams'\n ]\n },\n dismiss_stale_reviews: true,\n require_code_owner_reviews: true,\n required_approving_review_count: 42\n },\n restrictions: {\n users: [\n 'users'\n ],\n teams: [\n 'teams'\n ],\n apps: [\n 'apps'\n ]\n }\n})", + "html": "
await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch',\n  required_status_checks: {\n    strict: true,\n    contexts: [\n      'contexts'\n    ],\n    checks: [\n      {\n        context: 'context',\n        app_id: 'app_id'\n      }\n    ]\n  },\n  enforce_admins: true,\n  required_pull_request_reviews: {\n    dismissal_restrictions: {\n      users: [\n        'users'\n      ],\n      teams: [\n        'teams'\n      ]\n    },\n    dismiss_stale_reviews: true,\n    require_code_owner_reviews: true,\n    required_approving_review_count: 42\n  },\n  restrictions: {\n    users: [\n      'users'\n    ],\n    teams: [\n      'teams'\n    ],\n    apps: [\n      'apps'\n    ]\n  }\n})\n
" } ], "summary": "Update branch protection", @@ -37554,6 +37554,64 @@ "rawType": "array", "rawDescription": "The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.", "childParamsGroups": [] + }, + "checks": { + "type": "array of objects", + "description": "

The list of status checks to require in order to merge into this branch.

", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string", + "description": "

The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + "app_id": { + "type": "string", + "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "name": "app_id", + "in": "body", + "rawType": "string", + "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "childParamsGroups": [] + } + } + }, + "name": "checks", + "in": "body", + "rawType": "array", + "rawDescription": "The list of status checks to require in order to merge into this branch.", + "childParamsGroups": [ + { + "parentName": "checks", + "parentType": "items", + "id": "checks-items", + "params": [ + { + "type": "string", + "description": "

The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "name": "app_id", + "in": "body", + "rawType": "string", + "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "childParamsGroups": [] + } + ] + } + ] } }, "required": [ @@ -37590,6 +37648,89 @@ "rawType": "array", "rawDescription": "The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.", "childParamsGroups": [] + }, + { + "type": "array of objects", + "description": "

The list of status checks to require in order to merge into this branch.

", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string", + "description": "

The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + "app_id": { + "type": "string", + "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "name": "app_id", + "in": "body", + "rawType": "string", + "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "childParamsGroups": [] + } + } + }, + "name": "checks", + "in": "body", + "rawType": "array", + "rawDescription": "The list of status checks to require in order to merge into this branch.", + "childParamsGroups": [ + { + "parentName": "checks", + "parentType": "items", + "id": "checks-items", + "params": [ + { + "type": "string", + "description": "

The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "name": "app_id", + "in": "body", + "rawType": "string", + "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "childParamsGroups": [] + } + ] + } + ] + } + ] + }, + { + "parentName": "checks", + "parentType": "items", + "id": "checks-items", + "params": [ + { + "type": "string", + "description": "

The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "name": "app_id", + "in": "body", + "rawType": "string", + "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "childParamsGroups": [] } ] } @@ -38095,6 +38236,64 @@ "rawType": "array", "rawDescription": "The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.", "childParamsGroups": [] + }, + "checks": { + "type": "array of objects", + "description": "

The list of status checks to require in order to merge into this branch.

", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string", + "description": "

The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + "app_id": { + "type": "string", + "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "name": "app_id", + "in": "body", + "rawType": "string", + "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "childParamsGroups": [] + } + } + }, + "name": "checks", + "in": "body", + "rawType": "array", + "rawDescription": "The list of status checks to require in order to merge into this branch.", + "childParamsGroups": [ + { + "parentName": "checks", + "parentType": "items", + "id": "checks-items", + "params": [ + { + "type": "string", + "description": "

The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "name": "app_id", + "in": "body", + "rawType": "string", + "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "childParamsGroups": [] + } + ] + } + ] } }, "required": [ @@ -38131,6 +38330,89 @@ "rawType": "array", "rawDescription": "The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.", "childParamsGroups": [] + }, + { + "type": "array of objects", + "description": "

The list of status checks to require in order to merge into this branch.

", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string", + "description": "

The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + "app_id": { + "type": "string", + "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "name": "app_id", + "in": "body", + "rawType": "string", + "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "childParamsGroups": [] + } + } + }, + "name": "checks", + "in": "body", + "rawType": "array", + "rawDescription": "The list of status checks to require in order to merge into this branch.", + "childParamsGroups": [ + { + "parentName": "checks", + "parentType": "items", + "id": "checks-items", + "params": [ + { + "type": "string", + "description": "

The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "name": "app_id", + "in": "body", + "rawType": "string", + "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "childParamsGroups": [] + } + ] + } + ] + } + ] + }, + { + "parentName": "checks", + "parentType": "items", + "id": "checks-items", + "params": [ + { + "type": "string", + "description": "

The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "name": "app_id", + "in": "body", + "rawType": "string", + "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "childParamsGroups": [] } ] } diff --git a/lib/rest/static/decorated/ghes-3.3.json b/lib/rest/static/decorated/ghes-3.3.json index 482ada3c8064..543f7f646c32 100644 --- a/lib/rest/static/decorated/ghes-3.3.json +++ b/lib/rest/static/decorated/ghes-3.3.json @@ -37739,13 +37739,13 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection \\\n -d '{\"required_status_checks\":{\"strict\":true,\"contexts\":[\"contexts\"]},\"enforce_admins\":true,\"required_pull_request_reviews\":{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":42},\"restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"],\"apps\":[\"apps\"]}}'", - "html": "
curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection \\\n  -d '{\"required_status_checks\":{\"strict\":true,\"contexts\":[\"contexts\"]},\"enforce_admins\":true,\"required_pull_request_reviews\":{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":42},\"restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"],\"apps\":[\"apps\"]}}'
" + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection \\\n -d '{\"required_status_checks\":{\"strict\":true,\"contexts\":[\"contexts\"],\"checks\":[{\"context\":\"context\",\"app_id\":\"app_id\"}]},\"enforce_admins\":true,\"required_pull_request_reviews\":{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":42},\"restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"],\"apps\":[\"apps\"]}}'", + "html": "
curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection \\\n  -d '{\"required_status_checks\":{\"strict\":true,\"contexts\":[\"contexts\"],\"checks\":[{\"context\":\"context\",\"app_id\":\"app_id\"}]},\"enforce_admins\":true,\"required_pull_request_reviews\":{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":42},\"restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"],\"apps\":[\"apps\"]}}'
" }, { "lang": "JavaScript", - "source": "await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch',\n required_status_checks: {\n strict: true,\n contexts: [\n 'contexts'\n ]\n },\n enforce_admins: true,\n required_pull_request_reviews: {\n dismissal_restrictions: {\n users: [\n 'users'\n ],\n teams: [\n 'teams'\n ]\n },\n dismiss_stale_reviews: true,\n require_code_owner_reviews: true,\n required_approving_review_count: 42\n },\n restrictions: {\n users: [\n 'users'\n ],\n teams: [\n 'teams'\n ],\n apps: [\n 'apps'\n ]\n }\n})", - "html": "
await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch',\n  required_status_checks: {\n    strict: true,\n    contexts: [\n      'contexts'\n    ]\n  },\n  enforce_admins: true,\n  required_pull_request_reviews: {\n    dismissal_restrictions: {\n      users: [\n        'users'\n      ],\n      teams: [\n        'teams'\n      ]\n    },\n    dismiss_stale_reviews: true,\n    require_code_owner_reviews: true,\n    required_approving_review_count: 42\n  },\n  restrictions: {\n    users: [\n      'users'\n    ],\n    teams: [\n      'teams'\n    ],\n    apps: [\n      'apps'\n    ]\n  }\n})\n
" + "source": "await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch',\n required_status_checks: {\n strict: true,\n contexts: [\n 'contexts'\n ],\n checks: [\n {\n context: 'context',\n app_id: 'app_id'\n }\n ]\n },\n enforce_admins: true,\n required_pull_request_reviews: {\n dismissal_restrictions: {\n users: [\n 'users'\n ],\n teams: [\n 'teams'\n ]\n },\n dismiss_stale_reviews: true,\n require_code_owner_reviews: true,\n required_approving_review_count: 42\n },\n restrictions: {\n users: [\n 'users'\n ],\n teams: [\n 'teams'\n ],\n apps: [\n 'apps'\n ]\n }\n})", + "html": "
await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch',\n  required_status_checks: {\n    strict: true,\n    contexts: [\n      'contexts'\n    ],\n    checks: [\n      {\n        context: 'context',\n        app_id: 'app_id'\n      }\n    ]\n  },\n  enforce_admins: true,\n  required_pull_request_reviews: {\n    dismissal_restrictions: {\n      users: [\n        'users'\n      ],\n      teams: [\n        'teams'\n      ]\n    },\n    dismiss_stale_reviews: true,\n    require_code_owner_reviews: true,\n    required_approving_review_count: 42\n  },\n  restrictions: {\n    users: [\n      'users'\n    ],\n    teams: [\n      'teams'\n    ],\n    apps: [\n      'apps'\n    ]\n  }\n})\n
" } ], "summary": "Update branch protection", @@ -37790,6 +37790,64 @@ "rawType": "array", "rawDescription": "The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.", "childParamsGroups": [] + }, + "checks": { + "type": "array of objects", + "description": "

The list of status checks to require in order to merge into this branch.

", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string", + "description": "

The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + "app_id": { + "type": "string", + "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "name": "app_id", + "in": "body", + "rawType": "string", + "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "childParamsGroups": [] + } + } + }, + "name": "checks", + "in": "body", + "rawType": "array", + "rawDescription": "The list of status checks to require in order to merge into this branch.", + "childParamsGroups": [ + { + "parentName": "checks", + "parentType": "items", + "id": "checks-items", + "params": [ + { + "type": "string", + "description": "

The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "name": "app_id", + "in": "body", + "rawType": "string", + "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "childParamsGroups": [] + } + ] + } + ] } }, "required": [ @@ -37826,6 +37884,89 @@ "rawType": "array", "rawDescription": "The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.", "childParamsGroups": [] + }, + { + "type": "array of objects", + "description": "

The list of status checks to require in order to merge into this branch.

", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string", + "description": "

The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + "app_id": { + "type": "string", + "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "name": "app_id", + "in": "body", + "rawType": "string", + "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "childParamsGroups": [] + } + } + }, + "name": "checks", + "in": "body", + "rawType": "array", + "rawDescription": "The list of status checks to require in order to merge into this branch.", + "childParamsGroups": [ + { + "parentName": "checks", + "parentType": "items", + "id": "checks-items", + "params": [ + { + "type": "string", + "description": "

The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "name": "app_id", + "in": "body", + "rawType": "string", + "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "childParamsGroups": [] + } + ] + } + ] + } + ] + }, + { + "parentName": "checks", + "parentType": "items", + "id": "checks-items", + "params": [ + { + "type": "string", + "description": "

The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "name": "app_id", + "in": "body", + "rawType": "string", + "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "childParamsGroups": [] } ] } @@ -38323,6 +38464,64 @@ "rawType": "array", "rawDescription": "The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.", "childParamsGroups": [] + }, + "checks": { + "type": "array of objects", + "description": "

The list of status checks to require in order to merge into this branch.

", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string", + "description": "

The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + "app_id": { + "type": "string", + "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "name": "app_id", + "in": "body", + "rawType": "string", + "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "childParamsGroups": [] + } + } + }, + "name": "checks", + "in": "body", + "rawType": "array", + "rawDescription": "The list of status checks to require in order to merge into this branch.", + "childParamsGroups": [ + { + "parentName": "checks", + "parentType": "items", + "id": "checks-items", + "params": [ + { + "type": "string", + "description": "

The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "name": "app_id", + "in": "body", + "rawType": "string", + "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "childParamsGroups": [] + } + ] + } + ] } }, "required": [ @@ -38359,6 +38558,89 @@ "rawType": "array", "rawDescription": "The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.", "childParamsGroups": [] + }, + { + "type": "array of objects", + "description": "

The list of status checks to require in order to merge into this branch.

", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string", + "description": "

The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + "app_id": { + "type": "string", + "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "name": "app_id", + "in": "body", + "rawType": "string", + "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "childParamsGroups": [] + } + } + }, + "name": "checks", + "in": "body", + "rawType": "array", + "rawDescription": "The list of status checks to require in order to merge into this branch.", + "childParamsGroups": [ + { + "parentName": "checks", + "parentType": "items", + "id": "checks-items", + "params": [ + { + "type": "string", + "description": "

The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "name": "app_id", + "in": "body", + "rawType": "string", + "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "childParamsGroups": [] + } + ] + } + ] + } + ] + }, + { + "parentName": "checks", + "parentType": "items", + "id": "checks-items", + "params": [ + { + "type": "string", + "description": "

The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "name": "app_id", + "in": "body", + "rawType": "string", + "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "childParamsGroups": [] } ] } diff --git a/lib/rest/static/decorated/github.ae.json b/lib/rest/static/decorated/github.ae.json index 21871c8450b9..c27d68afe0a6 100644 --- a/lib/rest/static/decorated/github.ae.json +++ b/lib/rest/static/decorated/github.ae.json @@ -29507,13 +29507,13 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection \\\n -d '{\"required_status_checks\":{\"strict\":true,\"contexts\":[\"contexts\"]},\"enforce_admins\":true,\"required_pull_request_reviews\":{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":42},\"restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"],\"apps\":[\"apps\"]}}'", - "html": "
curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection \\\n  -d '{\"required_status_checks\":{\"strict\":true,\"contexts\":[\"contexts\"]},\"enforce_admins\":true,\"required_pull_request_reviews\":{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":42},\"restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"],\"apps\":[\"apps\"]}}'
" + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection \\\n -d '{\"required_status_checks\":{\"strict\":true,\"contexts\":[\"contexts\"],\"checks\":[{\"context\":\"context\",\"app_id\":\"app_id\"}]},\"enforce_admins\":true,\"required_pull_request_reviews\":{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":42},\"restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"],\"apps\":[\"apps\"]}}'", + "html": "
curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection \\\n  -d '{\"required_status_checks\":{\"strict\":true,\"contexts\":[\"contexts\"],\"checks\":[{\"context\":\"context\",\"app_id\":\"app_id\"}]},\"enforce_admins\":true,\"required_pull_request_reviews\":{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":42},\"restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"],\"apps\":[\"apps\"]}}'
" }, { "lang": "JavaScript", - "source": "await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch',\n required_status_checks: {\n strict: true,\n contexts: [\n 'contexts'\n ]\n },\n enforce_admins: true,\n required_pull_request_reviews: {\n dismissal_restrictions: {\n users: [\n 'users'\n ],\n teams: [\n 'teams'\n ]\n },\n dismiss_stale_reviews: true,\n require_code_owner_reviews: true,\n required_approving_review_count: 42\n },\n restrictions: {\n users: [\n 'users'\n ],\n teams: [\n 'teams'\n ],\n apps: [\n 'apps'\n ]\n }\n})", - "html": "
await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch',\n  required_status_checks: {\n    strict: true,\n    contexts: [\n      'contexts'\n    ]\n  },\n  enforce_admins: true,\n  required_pull_request_reviews: {\n    dismissal_restrictions: {\n      users: [\n        'users'\n      ],\n      teams: [\n        'teams'\n      ]\n    },\n    dismiss_stale_reviews: true,\n    require_code_owner_reviews: true,\n    required_approving_review_count: 42\n  },\n  restrictions: {\n    users: [\n      'users'\n    ],\n    teams: [\n      'teams'\n    ],\n    apps: [\n      'apps'\n    ]\n  }\n})\n
" + "source": "await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch',\n required_status_checks: {\n strict: true,\n contexts: [\n 'contexts'\n ],\n checks: [\n {\n context: 'context',\n app_id: 'app_id'\n }\n ]\n },\n enforce_admins: true,\n required_pull_request_reviews: {\n dismissal_restrictions: {\n users: [\n 'users'\n ],\n teams: [\n 'teams'\n ]\n },\n dismiss_stale_reviews: true,\n require_code_owner_reviews: true,\n required_approving_review_count: 42\n },\n restrictions: {\n users: [\n 'users'\n ],\n teams: [\n 'teams'\n ],\n apps: [\n 'apps'\n ]\n }\n})", + "html": "
await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch',\n  required_status_checks: {\n    strict: true,\n    contexts: [\n      'contexts'\n    ],\n    checks: [\n      {\n        context: 'context',\n        app_id: 'app_id'\n      }\n    ]\n  },\n  enforce_admins: true,\n  required_pull_request_reviews: {\n    dismissal_restrictions: {\n      users: [\n        'users'\n      ],\n      teams: [\n        'teams'\n      ]\n    },\n    dismiss_stale_reviews: true,\n    require_code_owner_reviews: true,\n    required_approving_review_count: 42\n  },\n  restrictions: {\n    users: [\n      'users'\n    ],\n    teams: [\n      'teams'\n    ],\n    apps: [\n      'apps'\n    ]\n  }\n})\n
" } ], "summary": "Update branch protection", @@ -29558,6 +29558,64 @@ "rawType": "array", "rawDescription": "The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.", "childParamsGroups": [] + }, + "checks": { + "type": "array of objects", + "description": "

The list of status checks to require in order to merge into this branch.

", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string", + "description": "

The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + "app_id": { + "type": "string", + "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "name": "app_id", + "in": "body", + "rawType": "string", + "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "childParamsGroups": [] + } + } + }, + "name": "checks", + "in": "body", + "rawType": "array", + "rawDescription": "The list of status checks to require in order to merge into this branch.", + "childParamsGroups": [ + { + "parentName": "checks", + "parentType": "items", + "id": "checks-items", + "params": [ + { + "type": "string", + "description": "

The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "name": "app_id", + "in": "body", + "rawType": "string", + "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "childParamsGroups": [] + } + ] + } + ] } }, "required": [ @@ -29594,6 +29652,89 @@ "rawType": "array", "rawDescription": "The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.", "childParamsGroups": [] + }, + { + "type": "array of objects", + "description": "

The list of status checks to require in order to merge into this branch.

", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string", + "description": "

The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + "app_id": { + "type": "string", + "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "name": "app_id", + "in": "body", + "rawType": "string", + "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "childParamsGroups": [] + } + } + }, + "name": "checks", + "in": "body", + "rawType": "array", + "rawDescription": "The list of status checks to require in order to merge into this branch.", + "childParamsGroups": [ + { + "parentName": "checks", + "parentType": "items", + "id": "checks-items", + "params": [ + { + "type": "string", + "description": "

The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "name": "app_id", + "in": "body", + "rawType": "string", + "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "childParamsGroups": [] + } + ] + } + ] + } + ] + }, + { + "parentName": "checks", + "parentType": "items", + "id": "checks-items", + "params": [ + { + "type": "string", + "description": "

The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "name": "app_id", + "in": "body", + "rawType": "string", + "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "childParamsGroups": [] } ] } @@ -30091,6 +30232,64 @@ "rawType": "array", "rawDescription": "The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.", "childParamsGroups": [] + }, + "checks": { + "type": "array of objects", + "description": "

The list of status checks to require in order to merge into this branch.

", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string", + "description": "

The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + "app_id": { + "type": "string", + "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "name": "app_id", + "in": "body", + "rawType": "string", + "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "childParamsGroups": [] + } + } + }, + "name": "checks", + "in": "body", + "rawType": "array", + "rawDescription": "The list of status checks to require in order to merge into this branch.", + "childParamsGroups": [ + { + "parentName": "checks", + "parentType": "items", + "id": "checks-items", + "params": [ + { + "type": "string", + "description": "

The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "name": "app_id", + "in": "body", + "rawType": "string", + "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "childParamsGroups": [] + } + ] + } + ] } }, "required": [ @@ -30127,6 +30326,89 @@ "rawType": "array", "rawDescription": "The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.", "childParamsGroups": [] + }, + { + "type": "array of objects", + "description": "

The list of status checks to require in order to merge into this branch.

", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string", + "description": "

The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + "app_id": { + "type": "string", + "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "name": "app_id", + "in": "body", + "rawType": "string", + "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "childParamsGroups": [] + } + } + }, + "name": "checks", + "in": "body", + "rawType": "array", + "rawDescription": "The list of status checks to require in order to merge into this branch.", + "childParamsGroups": [ + { + "parentName": "checks", + "parentType": "items", + "id": "checks-items", + "params": [ + { + "type": "string", + "description": "

The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "name": "app_id", + "in": "body", + "rawType": "string", + "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "childParamsGroups": [] + } + ] + } + ] + } + ] + }, + { + "parentName": "checks", + "parentType": "items", + "id": "checks-items", + "params": [ + { + "type": "string", + "description": "

The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.

", + "name": "app_id", + "in": "body", + "rawType": "string", + "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "childParamsGroups": [] } ] } diff --git a/lib/rest/static/dereferenced/api.github.com.deref.json b/lib/rest/static/dereferenced/api.github.com.deref.json index 9367e7f9dc75..e6bb3c9048dd 100644 --- a/lib/rest/static/dereferenced/api.github.com.deref.json +++ b/lib/rest/static/dereferenced/api.github.com.deref.json @@ -150444,6 +150444,25 @@ "type": "string" } }, + "checks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string" + }, + "app_id": { + "type": "string", + "nullable": true + } + }, + "required": [ + "context", + "app_id" + ] + } + }, "contexts_url": { "type": "string" }, @@ -151844,6 +151863,25 @@ "type": "string" } }, + "checks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string" + }, + "app_id": { + "type": "string", + "nullable": true + } + }, + "required": [ + "context", + "app_id" + ] + } + }, "contexts_url": { "type": "string" }, @@ -152735,6 +152773,25 @@ "type": "string" } }, + "checks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string" + }, + "app_id": { + "type": "string", + "nullable": true + } + }, + "required": [ + "context", + "app_id" + ] + } + }, "contexts_url": { "type": "string" }, @@ -153706,6 +153763,23 @@ "items": { "type": "string" } + }, + "checks": { + "type": "array", + "description": "The list of status checks to require in order to merge into this branch.", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string", + "description": "The name of the required check" + }, + "app_id": { + "type": "string", + "description": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source." + } + } + } } }, "required": [ @@ -153891,6 +153965,22 @@ "type": "string" } }, + "checks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string", + "example": "continuous-integration/travis-ci" + }, + "app_id": { + "type": "string", + "nullable": true + } + } + } + }, "contexts_url": { "type": "string", "format": "uri", @@ -156484,6 +156574,22 @@ "type": "string" } }, + "checks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string", + "example": "continuous-integration/travis-ci" + }, + "app_id": { + "type": "string", + "nullable": true + } + } + } + }, "contexts_url": { "type": "string", "format": "uri", @@ -156642,6 +156748,22 @@ "type": "string" } }, + "checks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string", + "example": "continuous-integration/travis-ci" + }, + "app_id": { + "type": "string", + "nullable": true + } + } + } + }, "contexts_url": { "type": "string", "format": "uri", @@ -162894,6 +163016,25 @@ "type": "string" } }, + "checks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string" + }, + "app_id": { + "type": "string", + "nullable": true + } + }, + "required": [ + "context", + "app_id" + ] + } + }, "contexts_url": { "type": "string" }, diff --git a/lib/rest/static/dereferenced/ghes-3.0.deref.json b/lib/rest/static/dereferenced/ghes-3.0.deref.json index d040171daef7..4cff9118fddf 100644 --- a/lib/rest/static/dereferenced/ghes-3.0.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.0.deref.json @@ -128529,6 +128529,25 @@ "type": "string" } }, + "checks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string" + }, + "app_id": { + "type": "string", + "nullable": true + } + }, + "required": [ + "context", + "app_id" + ] + } + }, "contexts_url": { "type": "string" }, @@ -129929,6 +129948,25 @@ "type": "string" } }, + "checks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string" + }, + "app_id": { + "type": "string", + "nullable": true + } + }, + "required": [ + "context", + "app_id" + ] + } + }, "contexts_url": { "type": "string" }, @@ -130820,6 +130858,25 @@ "type": "string" } }, + "checks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string" + }, + "app_id": { + "type": "string", + "nullable": true + } + }, + "required": [ + "context", + "app_id" + ] + } + }, "contexts_url": { "type": "string" }, @@ -131798,6 +131855,23 @@ "items": { "type": "string" } + }, + "checks": { + "type": "array", + "description": "The list of status checks to require in order to merge into this branch.", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string", + "description": "The name of the required check" + }, + "app_id": { + "type": "string", + "description": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source." + } + } + } } }, "required": [ @@ -131983,6 +132057,22 @@ "type": "string" } }, + "checks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string", + "example": "continuous-integration/travis-ci" + }, + "app_id": { + "type": "string", + "nullable": true + } + } + } + }, "contexts_url": { "type": "string", "format": "uri", @@ -134618,6 +134708,22 @@ "type": "string" } }, + "checks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string", + "example": "continuous-integration/travis-ci" + }, + "app_id": { + "type": "string", + "nullable": true + } + } + } + }, "contexts_url": { "type": "string", "format": "uri", @@ -134776,6 +134882,22 @@ "type": "string" } }, + "checks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string", + "example": "continuous-integration/travis-ci" + }, + "app_id": { + "type": "string", + "nullable": true + } + } + } + }, "contexts_url": { "type": "string", "format": "uri", diff --git a/lib/rest/static/dereferenced/ghes-3.1.deref.json b/lib/rest/static/dereferenced/ghes-3.1.deref.json index d9e992ee1e19..5de8dc1ea1f9 100644 --- a/lib/rest/static/dereferenced/ghes-3.1.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.1.deref.json @@ -128844,6 +128844,25 @@ "type": "string" } }, + "checks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string" + }, + "app_id": { + "type": "string", + "nullable": true + } + }, + "required": [ + "context", + "app_id" + ] + } + }, "contexts_url": { "type": "string" }, @@ -130244,6 +130263,25 @@ "type": "string" } }, + "checks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string" + }, + "app_id": { + "type": "string", + "nullable": true + } + }, + "required": [ + "context", + "app_id" + ] + } + }, "contexts_url": { "type": "string" }, @@ -131135,6 +131173,25 @@ "type": "string" } }, + "checks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string" + }, + "app_id": { + "type": "string", + "nullable": true + } + }, + "required": [ + "context", + "app_id" + ] + } + }, "contexts_url": { "type": "string" }, @@ -132113,6 +132170,23 @@ "items": { "type": "string" } + }, + "checks": { + "type": "array", + "description": "The list of status checks to require in order to merge into this branch.", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string", + "description": "The name of the required check" + }, + "app_id": { + "type": "string", + "description": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source." + } + } + } } }, "required": [ @@ -132298,6 +132372,22 @@ "type": "string" } }, + "checks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string", + "example": "continuous-integration/travis-ci" + }, + "app_id": { + "type": "string", + "nullable": true + } + } + } + }, "contexts_url": { "type": "string", "format": "uri", @@ -134933,6 +135023,22 @@ "type": "string" } }, + "checks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string", + "example": "continuous-integration/travis-ci" + }, + "app_id": { + "type": "string", + "nullable": true + } + } + } + }, "contexts_url": { "type": "string", "format": "uri", @@ -135091,6 +135197,22 @@ "type": "string" } }, + "checks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string", + "example": "continuous-integration/travis-ci" + }, + "app_id": { + "type": "string", + "nullable": true + } + } + } + }, "contexts_url": { "type": "string", "format": "uri", @@ -141343,6 +141465,25 @@ "type": "string" } }, + "checks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string" + }, + "app_id": { + "type": "string", + "nullable": true + } + }, + "required": [ + "context", + "app_id" + ] + } + }, "contexts_url": { "type": "string" }, diff --git a/lib/rest/static/dereferenced/ghes-3.2.deref.json b/lib/rest/static/dereferenced/ghes-3.2.deref.json index eee970a7cb5a..38398ff96d5c 100644 --- a/lib/rest/static/dereferenced/ghes-3.2.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.2.deref.json @@ -132461,6 +132461,25 @@ "type": "string" } }, + "checks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string" + }, + "app_id": { + "type": "string", + "nullable": true + } + }, + "required": [ + "context", + "app_id" + ] + } + }, "contexts_url": { "type": "string" }, @@ -133861,6 +133880,25 @@ "type": "string" } }, + "checks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string" + }, + "app_id": { + "type": "string", + "nullable": true + } + }, + "required": [ + "context", + "app_id" + ] + } + }, "contexts_url": { "type": "string" }, @@ -134752,6 +134790,25 @@ "type": "string" } }, + "checks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string" + }, + "app_id": { + "type": "string", + "nullable": true + } + }, + "required": [ + "context", + "app_id" + ] + } + }, "contexts_url": { "type": "string" }, @@ -135730,6 +135787,23 @@ "items": { "type": "string" } + }, + "checks": { + "type": "array", + "description": "The list of status checks to require in order to merge into this branch.", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string", + "description": "The name of the required check" + }, + "app_id": { + "type": "string", + "description": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source." + } + } + } } }, "required": [ @@ -135915,6 +135989,22 @@ "type": "string" } }, + "checks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string", + "example": "continuous-integration/travis-ci" + }, + "app_id": { + "type": "string", + "nullable": true + } + } + } + }, "contexts_url": { "type": "string", "format": "uri", @@ -138550,6 +138640,22 @@ "type": "string" } }, + "checks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string", + "example": "continuous-integration/travis-ci" + }, + "app_id": { + "type": "string", + "nullable": true + } + } + } + }, "contexts_url": { "type": "string", "format": "uri", @@ -138708,6 +138814,22 @@ "type": "string" } }, + "checks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string", + "example": "continuous-integration/travis-ci" + }, + "app_id": { + "type": "string", + "nullable": true + } + } + } + }, "contexts_url": { "type": "string", "format": "uri", @@ -144960,6 +145082,25 @@ "type": "string" } }, + "checks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string" + }, + "app_id": { + "type": "string", + "nullable": true + } + }, + "required": [ + "context", + "app_id" + ] + } + }, "contexts_url": { "type": "string" }, diff --git a/lib/rest/static/dereferenced/ghes-3.3.deref.json b/lib/rest/static/dereferenced/ghes-3.3.deref.json index f8f741b72f07..baba972dc47f 100644 --- a/lib/rest/static/dereferenced/ghes-3.3.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.3.deref.json @@ -139356,6 +139356,25 @@ "type": "string" } }, + "checks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string" + }, + "app_id": { + "type": "string", + "nullable": true + } + }, + "required": [ + "context", + "app_id" + ] + } + }, "contexts_url": { "type": "string" }, @@ -140756,6 +140775,25 @@ "type": "string" } }, + "checks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string" + }, + "app_id": { + "type": "string", + "nullable": true + } + }, + "required": [ + "context", + "app_id" + ] + } + }, "contexts_url": { "type": "string" }, @@ -141647,6 +141685,25 @@ "type": "string" } }, + "checks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string" + }, + "app_id": { + "type": "string", + "nullable": true + } + }, + "required": [ + "context", + "app_id" + ] + } + }, "contexts_url": { "type": "string" }, @@ -142618,6 +142675,23 @@ "items": { "type": "string" } + }, + "checks": { + "type": "array", + "description": "The list of status checks to require in order to merge into this branch.", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string", + "description": "The name of the required check" + }, + "app_id": { + "type": "string", + "description": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source." + } + } + } } }, "required": [ @@ -142803,6 +142877,22 @@ "type": "string" } }, + "checks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string", + "example": "continuous-integration/travis-ci" + }, + "app_id": { + "type": "string", + "nullable": true + } + } + } + }, "contexts_url": { "type": "string", "format": "uri", @@ -145396,6 +145486,22 @@ "type": "string" } }, + "checks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string", + "example": "continuous-integration/travis-ci" + }, + "app_id": { + "type": "string", + "nullable": true + } + } + } + }, "contexts_url": { "type": "string", "format": "uri", @@ -145554,6 +145660,22 @@ "type": "string" } }, + "checks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string", + "example": "continuous-integration/travis-ci" + }, + "app_id": { + "type": "string", + "nullable": true + } + } + } + }, "contexts_url": { "type": "string", "format": "uri", @@ -151806,6 +151928,25 @@ "type": "string" } }, + "checks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string" + }, + "app_id": { + "type": "string", + "nullable": true + } + }, + "required": [ + "context", + "app_id" + ] + } + }, "contexts_url": { "type": "string" }, diff --git a/lib/rest/static/dereferenced/github.ae.deref.json b/lib/rest/static/dereferenced/github.ae.deref.json index 298a7f2c9bd9..eb53effa3cd8 100644 --- a/lib/rest/static/dereferenced/github.ae.deref.json +++ b/lib/rest/static/dereferenced/github.ae.deref.json @@ -103577,6 +103577,25 @@ "type": "string" } }, + "checks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string" + }, + "app_id": { + "type": "string", + "nullable": true + } + }, + "required": [ + "context", + "app_id" + ] + } + }, "contexts_url": { "type": "string" }, @@ -104977,6 +104996,25 @@ "type": "string" } }, + "checks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string" + }, + "app_id": { + "type": "string", + "nullable": true + } + }, + "required": [ + "context", + "app_id" + ] + } + }, "contexts_url": { "type": "string" }, @@ -105868,6 +105906,25 @@ "type": "string" } }, + "checks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string" + }, + "app_id": { + "type": "string", + "nullable": true + } + }, + "required": [ + "context", + "app_id" + ] + } + }, "contexts_url": { "type": "string" }, @@ -106839,6 +106896,23 @@ "items": { "type": "string" } + }, + "checks": { + "type": "array", + "description": "The list of status checks to require in order to merge into this branch.", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string", + "description": "The name of the required check" + }, + "app_id": { + "type": "string", + "description": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source." + } + } + } } }, "required": [ @@ -107024,6 +107098,22 @@ "type": "string" } }, + "checks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string", + "example": "continuous-integration/travis-ci" + }, + "app_id": { + "type": "string", + "nullable": true + } + } + } + }, "contexts_url": { "type": "string", "format": "uri", @@ -109617,6 +109707,22 @@ "type": "string" } }, + "checks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string", + "example": "continuous-integration/travis-ci" + }, + "app_id": { + "type": "string", + "nullable": true + } + } + } + }, "contexts_url": { "type": "string", "format": "uri", @@ -109775,6 +109881,22 @@ "type": "string" } }, + "checks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string", + "example": "continuous-integration/travis-ci" + }, + "app_id": { + "type": "string", + "nullable": true + } + } + } + }, "contexts_url": { "type": "string", "format": "uri",