From ac4adf5c12d44b6db0c598e90b4e5f0b373de9fc Mon Sep 17 00:00:00 2001 From: Octokit Bot Date: Sat, 10 Jun 2023 16:28:09 -0500 Subject: [PATCH] feat: new endpoints for rulesets, update template to use type imports (#533) --- package-lock.json | 50 +++---- package.json | 4 +- .../update-endpoints/generated/endpoints.json | 141 ++++++++++++++---- scripts/update-endpoints/typescript.js | 2 +- src/generated/paginating-endpoints.ts | 29 +++- 5 files changed, 171 insertions(+), 55 deletions(-) diff --git a/package-lock.json b/package-lock.json index c344c7d2..3e973f79 100644 --- a/package-lock.json +++ b/package-lock.json @@ -10,11 +10,11 @@ "license": "MIT", "dependencies": { "@octokit/tsconfig": "^1.0.2", - "@octokit/types": "^9.2.3" + "@octokit/types": "^9.3.1" }, "devDependencies": { "@octokit/core": "^4.0.0", - "@octokit/plugin-rest-endpoint-methods": "^7.1.0", + "@octokit/plugin-rest-endpoint-methods": "^7.2.1", "@types/fetch-mock": "^7.3.1", "@types/jest": "^29.0.0", "@types/node": "^18.0.0", @@ -1827,18 +1827,17 @@ } }, "node_modules/@octokit/openapi-types": { - "version": "17.2.0", - "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-17.2.0.tgz", - "integrity": "sha512-MazrFNx4plbLsGl+LFesMo96eIXkFgEtaKbnNpdh4aQ0VM10aoylFsTYP1AEjkeoRNZiiPe3T6Gl2Hr8dJWdlQ==" + "version": "18.0.0", + "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-18.0.0.tgz", + "integrity": "sha512-V8GImKs3TeQRxRtXFpG2wl19V7444NIOTDF24AWuIbmNaNYOQMWRbjcGDXV5B+0n887fgDcuMNOmlul+k+oJtw==" }, "node_modules/@octokit/plugin-rest-endpoint-methods": { - "version": "7.1.2", - "resolved": "https://registry.npmjs.org/@octokit/plugin-rest-endpoint-methods/-/plugin-rest-endpoint-methods-7.1.2.tgz", - "integrity": "sha512-R0oJ7j6f/AdqPLtB9qRXLO+wjI9pctUn8Ka8UGfGaFCcCv3Otx14CshQ89K4E88pmyYZS8p0rNTiprML/81jig==", + "version": "7.2.1", + "resolved": "https://registry.npmjs.org/@octokit/plugin-rest-endpoint-methods/-/plugin-rest-endpoint-methods-7.2.1.tgz", + "integrity": "sha512-UmlNrrcF+AXxcxhZslTt1a/8aDxUKH0trrt/mJCxEPrWbW1ZEc+6xxcd5/n0iw3b+Xo8UBJQUKDr71+vNCBpRQ==", "dev": true, "dependencies": { - "@octokit/types": "^9.2.3", - "deprecation": "^2.3.1" + "@octokit/types": "^9.3.1" }, "engines": { "node": ">= 14" @@ -1884,11 +1883,11 @@ "integrity": "sha512-I0vDR0rdtP8p2lGMzvsJzbhdOWy405HcGovrspJ8RRibHnyRgggUSNO5AIox5LmqiwmatHKYsvj6VGFHkqS7lA==" }, "node_modules/@octokit/types": { - "version": "9.2.3", - "resolved": "https://registry.npmjs.org/@octokit/types/-/types-9.2.3.tgz", - "integrity": "sha512-MMeLdHyFIALioycq+LFcA71v0S2xpQUX2cw6pPbHQjaibcHYwLnmK/kMZaWuGfGfjBJZ3wRUq+dOaWsvrPJVvA==", + "version": "9.3.1", + "resolved": "https://registry.npmjs.org/@octokit/types/-/types-9.3.1.tgz", + "integrity": "sha512-zfJzyXLHC42sWcn2kS+oZ/DRvFZBYCCbfInZtwp1Uopl1qh6pRg4NSP/wFX1xCOpXvEkctiG1sxlSlkZmzvxdw==", "dependencies": { - "@octokit/openapi-types": "^17.2.0" + "@octokit/openapi-types": "^18.0.0" } }, "node_modules/@pkgjs/parseargs": { @@ -9069,18 +9068,17 @@ } }, "@octokit/openapi-types": { - "version": "17.2.0", - "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-17.2.0.tgz", - "integrity": "sha512-MazrFNx4plbLsGl+LFesMo96eIXkFgEtaKbnNpdh4aQ0VM10aoylFsTYP1AEjkeoRNZiiPe3T6Gl2Hr8dJWdlQ==" + "version": "18.0.0", + "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-18.0.0.tgz", + "integrity": "sha512-V8GImKs3TeQRxRtXFpG2wl19V7444NIOTDF24AWuIbmNaNYOQMWRbjcGDXV5B+0n887fgDcuMNOmlul+k+oJtw==" }, "@octokit/plugin-rest-endpoint-methods": { - "version": "7.1.2", - "resolved": "https://registry.npmjs.org/@octokit/plugin-rest-endpoint-methods/-/plugin-rest-endpoint-methods-7.1.2.tgz", - "integrity": "sha512-R0oJ7j6f/AdqPLtB9qRXLO+wjI9pctUn8Ka8UGfGaFCcCv3Otx14CshQ89K4E88pmyYZS8p0rNTiprML/81jig==", + "version": "7.2.1", + "resolved": "https://registry.npmjs.org/@octokit/plugin-rest-endpoint-methods/-/plugin-rest-endpoint-methods-7.2.1.tgz", + "integrity": "sha512-UmlNrrcF+AXxcxhZslTt1a/8aDxUKH0trrt/mJCxEPrWbW1ZEc+6xxcd5/n0iw3b+Xo8UBJQUKDr71+vNCBpRQ==", "dev": true, "requires": { - "@octokit/types": "^9.2.3", - "deprecation": "^2.3.1" + "@octokit/types": "^9.3.1" } }, "@octokit/request": { @@ -9114,11 +9112,11 @@ "integrity": "sha512-I0vDR0rdtP8p2lGMzvsJzbhdOWy405HcGovrspJ8RRibHnyRgggUSNO5AIox5LmqiwmatHKYsvj6VGFHkqS7lA==" }, "@octokit/types": { - "version": "9.2.3", - "resolved": "https://registry.npmjs.org/@octokit/types/-/types-9.2.3.tgz", - "integrity": "sha512-MMeLdHyFIALioycq+LFcA71v0S2xpQUX2cw6pPbHQjaibcHYwLnmK/kMZaWuGfGfjBJZ3wRUq+dOaWsvrPJVvA==", + "version": "9.3.1", + "resolved": "https://registry.npmjs.org/@octokit/types/-/types-9.3.1.tgz", + "integrity": "sha512-zfJzyXLHC42sWcn2kS+oZ/DRvFZBYCCbfInZtwp1Uopl1qh6pRg4NSP/wFX1xCOpXvEkctiG1sxlSlkZmzvxdw==", "requires": { - "@octokit/openapi-types": "^17.2.0" + "@octokit/openapi-types": "^18.0.0" } }, "@pkgjs/parseargs": { diff --git a/package.json b/package.json index 3dc335a5..e3994300 100644 --- a/package.json +++ b/package.json @@ -26,14 +26,14 @@ "license": "MIT", "dependencies": { "@octokit/tsconfig": "^1.0.2", - "@octokit/types": "^9.2.3" + "@octokit/types": "^9.3.1" }, "peerDependencies": { "@octokit/core": ">=4" }, "devDependencies": { "@octokit/core": "^4.0.0", - "@octokit/plugin-rest-endpoint-methods": "^7.1.0", + "@octokit/plugin-rest-endpoint-methods": "^7.2.1", "@types/fetch-mock": "^7.3.1", "@types/jest": "^29.0.0", "@types/node": "^18.0.0", diff --git a/scripts/update-endpoints/generated/endpoints.json b/scripts/update-endpoints/generated/endpoints.json index b093fdd8..840d3866 100644 --- a/scripts/update-endpoints/generated/endpoints.json +++ b/scripts/update-endpoints/generated/endpoints.json @@ -649,6 +649,63 @@ { "name": "workflow_id" } ] }, + { + "url": "/orgs/{org}/actions/runners/generate-jitconfig", + "id": "generate-runner-jitconfig-for-org", + "scope": "actions", + "documentationUrl": "https://docs.github.com/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-an-organization", + "renamed": null, + "responses": [ + { + "code": 201, + "schema": "{\"type\":\"object\",\"required\":[\"runner\",\"encoded_jit_config\"],\"properties\":{\"runner\":{\"title\":\"Self hosted runners\",\"description\":\"A self hosted runner\",\"type\":\"object\",\"properties\":{\"id\":{\"description\":\"The id of the runner.\",\"type\":\"integer\",\"example\":5},\"runner_group_id\":{\"description\":\"The id of the runner group.\",\"type\":\"integer\",\"example\":1},\"name\":{\"description\":\"The name of the runner.\",\"type\":\"string\",\"example\":\"iMac\"},\"os\":{\"description\":\"The Operating System of the runner.\",\"type\":\"string\",\"example\":\"macos\"},\"status\":{\"description\":\"The status of the runner.\",\"type\":\"string\",\"example\":\"online\"},\"busy\":{\"type\":\"boolean\"},\"labels\":{\"type\":\"array\",\"items\":{\"title\":\"Self hosted runner label\",\"description\":\"A label for a self hosted runner\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"integer\",\"description\":\"Unique identifier of the label.\"},\"name\":{\"type\":\"string\",\"description\":\"Name of the label.\"},\"type\":{\"type\":\"string\",\"description\":\"The type of label. Read-only labels are applied automatically when the runner is configured.\",\"enum\":[\"read-only\",\"custom\"]}},\"required\":[\"name\"]}}},\"required\":[\"id\",\"name\",\"os\",\"status\",\"busy\",\"labels\"]},\"encoded_jit_config\":{\"type\":\"string\",\"description\":\"The base64 encoded runner configuration.\"}}}" + }, + { + "code": 404, + "schema": "{\"title\":\"Basic Error\",\"description\":\"Basic Error\",\"type\":\"object\",\"properties\":{\"message\":{\"type\":\"string\"},\"documentation_url\":{\"type\":\"string\"},\"url\":{\"type\":\"string\"},\"status\":{\"type\":\"string\"}}}" + }, + { + "code": 422, + "schema": "{\"title\":\"Validation Error Simple\",\"description\":\"Validation Error Simple\",\"type\":\"object\",\"required\":[\"message\",\"documentation_url\"],\"properties\":{\"message\":{\"type\":\"string\"},\"documentation_url\":{\"type\":\"string\"},\"errors\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}}}}" + } + ], + "parameters": [ + { "name": "org" }, + { "name": "name" }, + { "name": "runner_group_id" }, + { "name": "labels" }, + { "name": "work_folder" } + ] + }, + { + "url": "/repos/{owner}/{repo}/actions/runners/generate-jitconfig", + "id": "generate-runner-jitconfig-for-repo", + "scope": "actions", + "documentationUrl": "https://docs.github.com/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-a-repository", + "renamed": null, + "responses": [ + { + "code": 201, + "schema": "{\"type\":\"object\",\"required\":[\"runner\",\"encoded_jit_config\"],\"properties\":{\"runner\":{\"title\":\"Self hosted runners\",\"description\":\"A self hosted runner\",\"type\":\"object\",\"properties\":{\"id\":{\"description\":\"The id of the runner.\",\"type\":\"integer\",\"example\":5},\"runner_group_id\":{\"description\":\"The id of the runner group.\",\"type\":\"integer\",\"example\":1},\"name\":{\"description\":\"The name of the runner.\",\"type\":\"string\",\"example\":\"iMac\"},\"os\":{\"description\":\"The Operating System of the runner.\",\"type\":\"string\",\"example\":\"macos\"},\"status\":{\"description\":\"The status of the runner.\",\"type\":\"string\",\"example\":\"online\"},\"busy\":{\"type\":\"boolean\"},\"labels\":{\"type\":\"array\",\"items\":{\"title\":\"Self hosted runner label\",\"description\":\"A label for a self hosted runner\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"integer\",\"description\":\"Unique identifier of the label.\"},\"name\":{\"type\":\"string\",\"description\":\"Name of the label.\"},\"type\":{\"type\":\"string\",\"description\":\"The type of label. Read-only labels are applied automatically when the runner is configured.\",\"enum\":[\"read-only\",\"custom\"]}},\"required\":[\"name\"]}}},\"required\":[\"id\",\"name\",\"os\",\"status\",\"busy\",\"labels\"]},\"encoded_jit_config\":{\"type\":\"string\",\"description\":\"The base64 encoded runner configuration.\"}}}" + }, + { + "code": 404, + "schema": "{\"title\":\"Basic Error\",\"description\":\"Basic Error\",\"type\":\"object\",\"properties\":{\"message\":{\"type\":\"string\"},\"documentation_url\":{\"type\":\"string\"},\"url\":{\"type\":\"string\"},\"status\":{\"type\":\"string\"}}}" + }, + { + "code": 422, + "schema": "{\"title\":\"Validation Error Simple\",\"description\":\"Validation Error Simple\",\"type\":\"object\",\"required\":[\"message\",\"documentation_url\"],\"properties\":{\"message\":{\"type\":\"string\"},\"documentation_url\":{\"type\":\"string\"},\"errors\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}}}}" + } + ], + "parameters": [ + { "name": "owner" }, + { "name": "repo" }, + { "name": "name" }, + { "name": "runner_group_id" }, + { "name": "labels" }, + { "name": "work_folder" } + ] + }, { "url": "/repos/{owner}/{repo}/actions/caches", "id": "get-actions-cache-list", @@ -3705,7 +3762,8 @@ { "code": 404, "schema": "{\"title\":\"Basic Error\",\"description\":\"Basic Error\",\"type\":\"object\",\"properties\":{\"message\":{\"type\":\"string\"},\"documentation_url\":{\"type\":\"string\"},\"url\":{\"type\":\"string\"},\"status\":{\"type\":\"string\"}}}" - } + }, + { "code": 422, "schema": null } ], "parameters": [{ "name": "installation_id" }, { "name": "repository_id" }] }, @@ -3725,7 +3783,8 @@ { "code": 404, "schema": "{\"title\":\"Basic Error\",\"description\":\"Basic Error\",\"type\":\"object\",\"properties\":{\"message\":{\"type\":\"string\"},\"documentation_url\":{\"type\":\"string\"},\"url\":{\"type\":\"string\"},\"status\":{\"type\":\"string\"}}}" - } + }, + { "code": 422, "schema": null } ], "parameters": [{ "name": "installation_id" }, { "name": "repository_id" }] }, @@ -4387,7 +4446,7 @@ "responses": [ { "code": 200, - "schema": "{\"description\":\"Configuration for code scanning default setup.\",\"type\":\"object\",\"properties\":{\"state\":{\"description\":\"Code scanning default setup has been configured or not.\",\"type\":\"string\",\"enum\":[\"configured\",\"not-configured\"]},\"languages\":{\"description\":\"Languages to be analysed.\",\"type\":\"array\",\"items\":{\"type\":\"string\",\"enum\":[\"c\",\"cpp\",\"csharp\",\"go\",\"java\",\"javascript\",\"kotlin\",\"python\",\"ruby\",\"typescript\"]}},\"query_suite\":{\"description\":\"CodeQL query suite to be used.\",\"type\":\"string\",\"enum\":[\"default\",\"extended\"]},\"updated_at\":{\"description\":\"Timestamp of latest configuration update.\",\"nullable\":true,\"type\":\"string\",\"format\":\"date-time\",\"example\":\"2023-12-06T14:20:20.000Z\"}}}" + "schema": "{\"description\":\"Configuration for code scanning default setup.\",\"type\":\"object\",\"properties\":{\"state\":{\"description\":\"Code scanning default setup has been configured or not.\",\"type\":\"string\",\"enum\":[\"configured\",\"not-configured\"]},\"languages\":{\"description\":\"Languages to be analysed.\",\"type\":\"array\",\"items\":{\"type\":\"string\",\"enum\":[\"c-cpp\",\"csharp\",\"go\",\"java-kotlin\",\"javascript-typescript\",\"javascript\",\"python\",\"ruby\",\"typescript\"]}},\"query_suite\":{\"description\":\"CodeQL query suite to be used.\",\"type\":\"string\",\"enum\":[\"default\",\"extended\"]},\"updated_at\":{\"description\":\"Timestamp of latest configuration update.\",\"nullable\":true,\"type\":\"string\",\"format\":\"date-time\",\"example\":\"2023-12-06T14:20:20.000Z\"}}}" }, { "code": 403, @@ -4894,6 +4953,7 @@ { "name": "repository_id" }, { "name": "ref" }, { "name": "location" }, + { "name": "geo" }, { "name": "client_ip" }, { "name": "machine" }, { "name": "devcontainer_path" }, @@ -5023,6 +5083,7 @@ { "name": "repo" }, { "name": "pull_number" }, { "name": "location" }, + { "name": "geo" }, { "name": "client_ip" }, { "name": "machine" }, { "name": "devcontainer_path" }, @@ -5078,6 +5139,7 @@ { "name": "repo" }, { "name": "ref" }, { "name": "location" }, + { "name": "geo" }, { "name": "client_ip" }, { "name": "machine" }, { "name": "devcontainer_path" }, @@ -7198,8 +7260,7 @@ { "name": "owner" }, { "name": "repo" }, { "name": "ref" }, - { "name": "sha" }, - { "name": "key" } + { "name": "sha" } ] }, { @@ -7745,6 +7806,14 @@ "code": 201, "schema": "{\"title\":\"Issue\",\"description\":\"Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"integer\",\"format\":\"int64\"},\"node_id\":{\"type\":\"string\"},\"url\":{\"description\":\"URL for the issue\",\"example\":\"https://api.github.com/repositories/42/issues/1\",\"type\":\"string\",\"format\":\"uri\"},\"repository_url\":{\"type\":\"string\",\"format\":\"uri\"},\"labels_url\":{\"type\":\"string\"},\"comments_url\":{\"type\":\"string\",\"format\":\"uri\"},\"events_url\":{\"type\":\"string\",\"format\":\"uri\"},\"html_url\":{\"type\":\"string\",\"format\":\"uri\"},\"number\":{\"description\":\"Number uniquely identifying the issue within its repository\",\"example\":42,\"type\":\"integer\"},\"state\":{\"description\":\"State of the issue; either 'open' or 'closed'\",\"example\":\"open\",\"type\":\"string\"},\"state_reason\":{\"description\":\"The reason for the current state\",\"example\":\"not_planned\",\"type\":\"string\",\"nullable\":true,\"enum\":[\"completed\",\"reopened\",\"not_planned\"]},\"title\":{\"description\":\"Title of the issue\",\"example\":\"Widget creation fails in Safari on OS X 10.8\",\"type\":\"string\"},\"body\":{\"description\":\"Contents of the issue\",\"example\":\"It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?\",\"type\":\"string\",\"nullable\":true},\"user\":{\"title\":\"Simple User\",\"description\":\"A GitHub user.\",\"type\":\"object\",\"properties\":{\"name\":{\"nullable\":true,\"type\":\"string\"},\"email\":{\"nullable\":true,\"type\":\"string\"},\"login\":{\"type\":\"string\",\"example\":\"octocat\"},\"id\":{\"type\":\"integer\",\"example\":1},\"node_id\":{\"type\":\"string\",\"example\":\"MDQ6VXNlcjE=\"},\"avatar_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://github.com/images/error/octocat_happy.gif\"},\"gravatar_id\":{\"type\":\"string\",\"example\":\"41d064eb2195891e12d0413f63227ea7\",\"nullable\":true},\"url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/users/octocat\"},\"html_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://github.com/octocat\"},\"followers_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/users/octocat/followers\"},\"following_url\":{\"type\":\"string\",\"example\":\"https://api.github.com/users/octocat/following{/other_user}\"},\"gists_url\":{\"type\":\"string\",\"example\":\"https://api.github.com/users/octocat/gists{/gist_id}\"},\"starred_url\":{\"type\":\"string\",\"example\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\"},\"subscriptions_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/users/octocat/subscriptions\"},\"organizations_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/users/octocat/orgs\"},\"repos_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/users/octocat/repos\"},\"events_url\":{\"type\":\"string\",\"example\":\"https://api.github.com/users/octocat/events{/privacy}\"},\"received_events_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/users/octocat/received_events\"},\"type\":{\"type\":\"string\",\"example\":\"User\"},\"site_admin\":{\"type\":\"boolean\"},\"starred_at\":{\"type\":\"string\",\"example\":\"\\\"2020-07-09T00:17:55Z\\\"\"}},\"required\":[\"avatar_url\",\"events_url\",\"followers_url\",\"following_url\",\"gists_url\",\"gravatar_id\",\"html_url\",\"id\",\"node_id\",\"login\",\"organizations_url\",\"received_events_url\",\"repos_url\",\"site_admin\",\"starred_url\",\"subscriptions_url\",\"type\",\"url\"],\"nullable\":true},\"labels\":{\"description\":\"Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository\",\"example\":[\"bug\",\"registration\"],\"type\":\"array\",\"items\":{\"oneOf\":[{\"type\":\"string\"},{\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"integer\",\"format\":\"int64\"},\"node_id\":{\"type\":\"string\"},\"url\":{\"type\":\"string\",\"format\":\"uri\"},\"name\":{\"type\":\"string\"},\"description\":{\"type\":\"string\",\"nullable\":true},\"color\":{\"type\":\"string\",\"nullable\":true},\"default\":{\"type\":\"boolean\"}}}]}},\"assignee\":{\"title\":\"Simple User\",\"description\":\"A GitHub user.\",\"type\":\"object\",\"properties\":{\"name\":{\"nullable\":true,\"type\":\"string\"},\"email\":{\"nullable\":true,\"type\":\"string\"},\"login\":{\"type\":\"string\",\"example\":\"octocat\"},\"id\":{\"type\":\"integer\",\"example\":1},\"node_id\":{\"type\":\"string\",\"example\":\"MDQ6VXNlcjE=\"},\"avatar_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://github.com/images/error/octocat_happy.gif\"},\"gravatar_id\":{\"type\":\"string\",\"example\":\"41d064eb2195891e12d0413f63227ea7\",\"nullable\":true},\"url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/users/octocat\"},\"html_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://github.com/octocat\"},\"followers_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/users/octocat/followers\"},\"following_url\":{\"type\":\"string\",\"example\":\"https://api.github.com/users/octocat/following{/other_user}\"},\"gists_url\":{\"type\":\"string\",\"example\":\"https://api.github.com/users/octocat/gists{/gist_id}\"},\"starred_url\":{\"type\":\"string\",\"example\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\"},\"subscriptions_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/users/octocat/subscriptions\"},\"organizations_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/users/octocat/orgs\"},\"repos_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/users/octocat/repos\"},\"events_url\":{\"type\":\"string\",\"example\":\"https://api.github.com/users/octocat/events{/privacy}\"},\"received_events_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/users/octocat/received_events\"},\"type\":{\"type\":\"string\",\"example\":\"User\"},\"site_admin\":{\"type\":\"boolean\"},\"starred_at\":{\"type\":\"string\",\"example\":\"\\\"2020-07-09T00:17:55Z\\\"\"}},\"required\":[\"avatar_url\",\"events_url\",\"followers_url\",\"following_url\",\"gists_url\",\"gravatar_id\",\"html_url\",\"id\",\"node_id\",\"login\",\"organizations_url\",\"received_events_url\",\"repos_url\",\"site_admin\",\"starred_url\",\"subscriptions_url\",\"type\",\"url\"],\"nullable\":true},\"assignees\":{\"type\":\"array\",\"items\":{\"title\":\"Simple User\",\"description\":\"A GitHub user.\",\"type\":\"object\",\"properties\":{\"name\":{\"nullable\":true,\"type\":\"string\"},\"email\":{\"nullable\":true,\"type\":\"string\"},\"login\":{\"type\":\"string\",\"example\":\"octocat\"},\"id\":{\"type\":\"integer\",\"example\":1},\"node_id\":{\"type\":\"string\",\"example\":\"MDQ6VXNlcjE=\"},\"avatar_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://github.com/images/error/octocat_happy.gif\"},\"gravatar_id\":{\"type\":\"string\",\"example\":\"41d064eb2195891e12d0413f63227ea7\",\"nullable\":true},\"url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/users/octocat\"},\"html_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://github.com/octocat\"},\"followers_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/users/octocat/followers\"},\"following_url\":{\"type\":\"string\",\"example\":\"https://api.github.com/users/octocat/following{/other_user}\"},\"gists_url\":{\"type\":\"string\",\"example\":\"https://api.github.com/users/octocat/gists{/gist_id}\"},\"starred_url\":{\"type\":\"string\",\"example\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\"},\"subscriptions_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/users/octocat/subscriptions\"},\"organizations_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/users/octocat/orgs\"},\"repos_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/users/octocat/repos\"},\"events_url\":{\"type\":\"string\",\"example\":\"https://api.github.com/users/octocat/events{/privacy}\"},\"received_events_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/users/octocat/received_events\"},\"type\":{\"type\":\"string\",\"example\":\"User\"},\"site_admin\":{\"type\":\"boolean\"},\"starred_at\":{\"type\":\"string\",\"example\":\"\\\"2020-07-09T00:17:55Z\\\"\"}},\"required\":[\"avatar_url\",\"events_url\",\"followers_url\",\"following_url\",\"gists_url\",\"gravatar_id\",\"html_url\",\"id\",\"node_id\",\"login\",\"organizations_url\",\"received_events_url\",\"repos_url\",\"site_admin\",\"starred_url\",\"subscriptions_url\",\"type\",\"url\"]},\"nullable\":true},\"milestone\":{\"title\":\"Milestone\",\"description\":\"A collection of related issues and pull requests.\",\"type\":\"object\",\"properties\":{\"url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\"},\"html_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://github.com/octocat/Hello-World/milestones/v1.0\"},\"labels_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\"},\"id\":{\"type\":\"integer\",\"example\":1002604},\"node_id\":{\"type\":\"string\",\"example\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\"},\"number\":{\"description\":\"The number of the milestone.\",\"type\":\"integer\",\"example\":42},\"state\":{\"description\":\"The state of the milestone.\",\"example\":\"open\",\"type\":\"string\",\"enum\":[\"open\",\"closed\"],\"default\":\"open\"},\"title\":{\"description\":\"The title of the milestone.\",\"example\":\"v1.0\",\"type\":\"string\"},\"description\":{\"type\":\"string\",\"example\":\"Tracking milestone for version 1.0\",\"nullable\":true},\"creator\":{\"title\":\"Simple User\",\"description\":\"A GitHub user.\",\"type\":\"object\",\"properties\":{\"name\":{\"nullable\":true,\"type\":\"string\"},\"email\":{\"nullable\":true,\"type\":\"string\"},\"login\":{\"type\":\"string\",\"example\":\"octocat\"},\"id\":{\"type\":\"integer\",\"example\":1},\"node_id\":{\"type\":\"string\",\"example\":\"MDQ6VXNlcjE=\"},\"avatar_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://github.com/images/error/octocat_happy.gif\"},\"gravatar_id\":{\"type\":\"string\",\"example\":\"41d064eb2195891e12d0413f63227ea7\",\"nullable\":true},\"url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/users/octocat\"},\"html_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://github.com/octocat\"},\"followers_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/users/octocat/followers\"},\"following_url\":{\"type\":\"string\",\"example\":\"https://api.github.com/users/octocat/following{/other_user}\"},\"gists_url\":{\"type\":\"string\",\"example\":\"https://api.github.com/users/octocat/gists{/gist_id}\"},\"starred_url\":{\"type\":\"string\",\"example\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\"},\"subscriptions_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/users/octocat/subscriptions\"},\"organizations_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/users/octocat/orgs\"},\"repos_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/users/octocat/repos\"},\"events_url\":{\"type\":\"string\",\"example\":\"https://api.github.com/users/octocat/events{/privacy}\"},\"received_events_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/users/octocat/received_events\"},\"type\":{\"type\":\"string\",\"example\":\"User\"},\"site_admin\":{\"type\":\"boolean\"},\"starred_at\":{\"type\":\"string\",\"example\":\"\\\"2020-07-09T00:17:55Z\\\"\"}},\"required\":[\"avatar_url\",\"events_url\",\"followers_url\",\"following_url\",\"gists_url\",\"gravatar_id\",\"html_url\",\"id\",\"node_id\",\"login\",\"organizations_url\",\"received_events_url\",\"repos_url\",\"site_admin\",\"starred_url\",\"subscriptions_url\",\"type\",\"url\"],\"nullable\":true},\"open_issues\":{\"type\":\"integer\",\"example\":4},\"closed_issues\":{\"type\":\"integer\",\"example\":8},\"created_at\":{\"type\":\"string\",\"format\":\"date-time\",\"example\":\"2011-04-10T20:09:31Z\"},\"updated_at\":{\"type\":\"string\",\"format\":\"date-time\",\"example\":\"2014-03-03T18:58:10Z\"},\"closed_at\":{\"type\":\"string\",\"format\":\"date-time\",\"example\":\"2013-02-12T13:22:01Z\",\"nullable\":true},\"due_on\":{\"type\":\"string\",\"format\":\"date-time\",\"example\":\"2012-10-09T23:39:01Z\",\"nullable\":true}},\"required\":[\"closed_issues\",\"creator\",\"description\",\"due_on\",\"closed_at\",\"id\",\"node_id\",\"labels_url\",\"html_url\",\"number\",\"open_issues\",\"state\",\"title\",\"url\",\"created_at\",\"updated_at\"],\"nullable\":true},\"locked\":{\"type\":\"boolean\"},\"active_lock_reason\":{\"type\":\"string\",\"nullable\":true},\"comments\":{\"type\":\"integer\"},\"pull_request\":{\"type\":\"object\",\"properties\":{\"merged_at\":{\"type\":\"string\",\"format\":\"date-time\",\"nullable\":true},\"diff_url\":{\"type\":\"string\",\"format\":\"uri\",\"nullable\":true},\"html_url\":{\"type\":\"string\",\"format\":\"uri\",\"nullable\":true},\"patch_url\":{\"type\":\"string\",\"format\":\"uri\",\"nullable\":true},\"url\":{\"type\":\"string\",\"format\":\"uri\",\"nullable\":true}},\"required\":[\"diff_url\",\"html_url\",\"patch_url\",\"url\"]},\"closed_at\":{\"type\":\"string\",\"format\":\"date-time\",\"nullable\":true},\"created_at\":{\"type\":\"string\",\"format\":\"date-time\"},\"updated_at\":{\"type\":\"string\",\"format\":\"date-time\"},\"draft\":{\"type\":\"boolean\"},\"closed_by\":{\"title\":\"Simple User\",\"description\":\"A GitHub user.\",\"type\":\"object\",\"properties\":{\"name\":{\"nullable\":true,\"type\":\"string\"},\"email\":{\"nullable\":true,\"type\":\"string\"},\"login\":{\"type\":\"string\",\"example\":\"octocat\"},\"id\":{\"type\":\"integer\",\"example\":1},\"node_id\":{\"type\":\"string\",\"example\":\"MDQ6VXNlcjE=\"},\"avatar_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://github.com/images/error/octocat_happy.gif\"},\"gravatar_id\":{\"type\":\"string\",\"example\":\"41d064eb2195891e12d0413f63227ea7\",\"nullable\":true},\"url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/users/octocat\"},\"html_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://github.com/octocat\"},\"followers_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/users/octocat/followers\"},\"following_url\":{\"type\":\"string\",\"example\":\"https://api.github.com/users/octocat/following{/other_user}\"},\"gists_url\":{\"type\":\"string\",\"example\":\"https://api.github.com/users/octocat/gists{/gist_id}\"},\"starred_url\":{\"type\":\"string\",\"example\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\"},\"subscriptions_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/users/octocat/subscriptions\"},\"organizations_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/users/octocat/orgs\"},\"repos_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/users/octocat/repos\"},\"events_url\":{\"type\":\"string\",\"example\":\"https://api.github.com/users/octocat/events{/privacy}\"},\"received_events_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/users/octocat/received_events\"},\"type\":{\"type\":\"string\",\"example\":\"User\"},\"site_admin\":{\"type\":\"boolean\"},\"starred_at\":{\"type\":\"string\",\"example\":\"\\\"2020-07-09T00:17:55Z\\\"\"}},\"required\":[\"avatar_url\",\"events_url\",\"followers_url\",\"following_url\",\"gists_url\",\"gravatar_id\",\"html_url\",\"id\",\"node_id\",\"login\",\"organizations_url\",\"received_events_url\",\"repos_url\",\"site_admin\",\"starred_url\",\"subscriptions_url\",\"type\",\"url\"],\"nullable\":true},\"body_html\":{\"type\":\"string\"},\"body_text\":{\"type\":\"string\"},\"timeline_url\":{\"type\":\"string\",\"format\":\"uri\"},\"repository\":{\"title\":\"Repository\",\"description\":\"A repository on GitHub.\",\"type\":\"object\",\"properties\":{\"id\":{\"description\":\"Unique identifier of the repository\",\"example\":42,\"type\":\"integer\"},\"node_id\":{\"type\":\"string\",\"example\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\"},\"name\":{\"description\":\"The name of the repository.\",\"type\":\"string\",\"example\":\"Team Environment\"},\"full_name\":{\"type\":\"string\",\"example\":\"octocat/Hello-World\"},\"license\":{\"title\":\"License Simple\",\"description\":\"License Simple\",\"type\":\"object\",\"properties\":{\"key\":{\"type\":\"string\",\"example\":\"mit\"},\"name\":{\"type\":\"string\",\"example\":\"MIT License\"},\"url\":{\"type\":\"string\",\"nullable\":true,\"format\":\"uri\",\"example\":\"https://api.github.com/licenses/mit\"},\"spdx_id\":{\"type\":\"string\",\"nullable\":true,\"example\":\"MIT\"},\"node_id\":{\"type\":\"string\",\"example\":\"MDc6TGljZW5zZW1pdA==\"},\"html_url\":{\"type\":\"string\",\"format\":\"uri\"}},\"required\":[\"key\",\"name\",\"url\",\"spdx_id\",\"node_id\"],\"nullable\":true},\"organization\":{\"title\":\"Simple User\",\"description\":\"A GitHub user.\",\"type\":\"object\",\"properties\":{\"name\":{\"nullable\":true,\"type\":\"string\"},\"email\":{\"nullable\":true,\"type\":\"string\"},\"login\":{\"type\":\"string\",\"example\":\"octocat\"},\"id\":{\"type\":\"integer\",\"example\":1},\"node_id\":{\"type\":\"string\",\"example\":\"MDQ6VXNlcjE=\"},\"avatar_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://github.com/images/error/octocat_happy.gif\"},\"gravatar_id\":{\"type\":\"string\",\"example\":\"41d064eb2195891e12d0413f63227ea7\",\"nullable\":true},\"url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/users/octocat\"},\"html_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://github.com/octocat\"},\"followers_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/users/octocat/followers\"},\"following_url\":{\"type\":\"string\",\"example\":\"https://api.github.com/users/octocat/following{/other_user}\"},\"gists_url\":{\"type\":\"string\",\"example\":\"https://api.github.com/users/octocat/gists{/gist_id}\"},\"starred_url\":{\"type\":\"string\",\"example\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\"},\"subscriptions_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/users/octocat/subscriptions\"},\"organizations_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/users/octocat/orgs\"},\"repos_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/users/octocat/repos\"},\"events_url\":{\"type\":\"string\",\"example\":\"https://api.github.com/users/octocat/events{/privacy}\"},\"received_events_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/users/octocat/received_events\"},\"type\":{\"type\":\"string\",\"example\":\"User\"},\"site_admin\":{\"type\":\"boolean\"},\"starred_at\":{\"type\":\"string\",\"example\":\"\\\"2020-07-09T00:17:55Z\\\"\"}},\"required\":[\"avatar_url\",\"events_url\",\"followers_url\",\"following_url\",\"gists_url\",\"gravatar_id\",\"html_url\",\"id\",\"node_id\",\"login\",\"organizations_url\",\"received_events_url\",\"repos_url\",\"site_admin\",\"starred_url\",\"subscriptions_url\",\"type\",\"url\"],\"nullable\":true},\"forks\":{\"type\":\"integer\"},\"permissions\":{\"type\":\"object\",\"properties\":{\"admin\":{\"type\":\"boolean\"},\"pull\":{\"type\":\"boolean\"},\"triage\":{\"type\":\"boolean\"},\"push\":{\"type\":\"boolean\"},\"maintain\":{\"type\":\"boolean\"}},\"required\":[\"admin\",\"pull\",\"push\"]},\"owner\":{\"title\":\"Simple User\",\"description\":\"A GitHub user.\",\"type\":\"object\",\"properties\":{\"name\":{\"nullable\":true,\"type\":\"string\"},\"email\":{\"nullable\":true,\"type\":\"string\"},\"login\":{\"type\":\"string\",\"example\":\"octocat\"},\"id\":{\"type\":\"integer\",\"example\":1},\"node_id\":{\"type\":\"string\",\"example\":\"MDQ6VXNlcjE=\"},\"avatar_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://github.com/images/error/octocat_happy.gif\"},\"gravatar_id\":{\"type\":\"string\",\"example\":\"41d064eb2195891e12d0413f63227ea7\",\"nullable\":true},\"url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/users/octocat\"},\"html_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://github.com/octocat\"},\"followers_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/users/octocat/followers\"},\"following_url\":{\"type\":\"string\",\"example\":\"https://api.github.com/users/octocat/following{/other_user}\"},\"gists_url\":{\"type\":\"string\",\"example\":\"https://api.github.com/users/octocat/gists{/gist_id}\"},\"starred_url\":{\"type\":\"string\",\"example\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\"},\"subscriptions_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/users/octocat/subscriptions\"},\"organizations_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/users/octocat/orgs\"},\"repos_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/users/octocat/repos\"},\"events_url\":{\"type\":\"string\",\"example\":\"https://api.github.com/users/octocat/events{/privacy}\"},\"received_events_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/users/octocat/received_events\"},\"type\":{\"type\":\"string\",\"example\":\"User\"},\"site_admin\":{\"type\":\"boolean\"},\"starred_at\":{\"type\":\"string\",\"example\":\"\\\"2020-07-09T00:17:55Z\\\"\"}},\"required\":[\"avatar_url\",\"events_url\",\"followers_url\",\"following_url\",\"gists_url\",\"gravatar_id\",\"html_url\",\"id\",\"node_id\",\"login\",\"organizations_url\",\"received_events_url\",\"repos_url\",\"site_admin\",\"starred_url\",\"subscriptions_url\",\"type\",\"url\"]},\"private\":{\"description\":\"Whether the repository is private or public.\",\"default\":false,\"type\":\"boolean\"},\"html_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://github.com/octocat/Hello-World\"},\"description\":{\"type\":\"string\",\"example\":\"This your first repo!\",\"nullable\":true},\"fork\":{\"type\":\"boolean\"},\"url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/repos/octocat/Hello-World\"},\"archive_url\":{\"type\":\"string\",\"example\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\"},\"assignees_url\":{\"type\":\"string\",\"example\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\"},\"blobs_url\":{\"type\":\"string\",\"example\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\"},\"branches_url\":{\"type\":\"string\",\"example\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\"},\"collaborators_url\":{\"type\":\"string\",\"example\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\"},\"comments_url\":{\"type\":\"string\",\"example\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\"},\"commits_url\":{\"type\":\"string\",\"example\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\"},\"compare_url\":{\"type\":\"string\",\"example\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\"},\"contents_url\":{\"type\":\"string\",\"example\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\"},\"contributors_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"http://api.github.com/repos/octocat/Hello-World/contributors\"},\"deployments_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"http://api.github.com/repos/octocat/Hello-World/deployments\"},\"downloads_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"http://api.github.com/repos/octocat/Hello-World/downloads\"},\"events_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"http://api.github.com/repos/octocat/Hello-World/events\"},\"forks_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"http://api.github.com/repos/octocat/Hello-World/forks\"},\"git_commits_url\":{\"type\":\"string\",\"example\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\"},\"git_refs_url\":{\"type\":\"string\",\"example\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\"},\"git_tags_url\":{\"type\":\"string\",\"example\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\"},\"git_url\":{\"type\":\"string\",\"example\":\"git:github.com/octocat/Hello-World.git\"},\"issue_comment_url\":{\"type\":\"string\",\"example\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\"},\"issue_events_url\":{\"type\":\"string\",\"example\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\"},\"issues_url\":{\"type\":\"string\",\"example\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\"},\"keys_url\":{\"type\":\"string\",\"example\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\"},\"labels_url\":{\"type\":\"string\",\"example\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\"},\"languages_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"http://api.github.com/repos/octocat/Hello-World/languages\"},\"merges_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"http://api.github.com/repos/octocat/Hello-World/merges\"},\"milestones_url\":{\"type\":\"string\",\"example\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\"},\"notifications_url\":{\"type\":\"string\",\"example\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\"},\"pulls_url\":{\"type\":\"string\",\"example\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\"},\"releases_url\":{\"type\":\"string\",\"example\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\"},\"ssh_url\":{\"type\":\"string\",\"example\":\"git@github.com:octocat/Hello-World.git\"},\"stargazers_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\"},\"statuses_url\":{\"type\":\"string\",\"example\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\"},\"subscribers_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\"},\"subscription_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"http://api.github.com/repos/octocat/Hello-World/subscription\"},\"tags_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"http://api.github.com/repos/octocat/Hello-World/tags\"},\"teams_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"http://api.github.com/repos/octocat/Hello-World/teams\"},\"trees_url\":{\"type\":\"string\",\"example\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\"},\"clone_url\":{\"type\":\"string\",\"example\":\"https://github.com/octocat/Hello-World.git\"},\"mirror_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"git:git.example.com/octocat/Hello-World\",\"nullable\":true},\"hooks_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"svn_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://svn.github.com/octocat/Hello-World\"},\"homepage\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://github.com\",\"nullable\":true},\"language\":{\"type\":\"string\",\"nullable\":true},\"forks_count\":{\"type\":\"integer\",\"example\":9},\"stargazers_count\":{\"type\":\"integer\",\"example\":80},\"watchers_count\":{\"type\":\"integer\",\"example\":80},\"size\":{\"description\":\"The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.\",\"type\":\"integer\",\"example\":108},\"default_branch\":{\"description\":\"The default branch of the repository.\",\"type\":\"string\",\"example\":\"master\"},\"open_issues_count\":{\"type\":\"integer\",\"example\":0},\"is_template\":{\"description\":\"Whether this repository acts as a template that can be used to generate new repositories.\",\"default\":false,\"type\":\"boolean\",\"example\":true},\"topics\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"has_issues\":{\"description\":\"Whether issues are enabled.\",\"default\":true,\"type\":\"boolean\",\"example\":true},\"has_projects\":{\"description\":\"Whether projects are enabled.\",\"default\":true,\"type\":\"boolean\",\"example\":true},\"has_wiki\":{\"description\":\"Whether the wiki is enabled.\",\"default\":true,\"type\":\"boolean\",\"example\":true},\"has_pages\":{\"type\":\"boolean\"},\"has_downloads\":{\"description\":\"Whether downloads are enabled.\",\"default\":true,\"type\":\"boolean\",\"example\":true},\"has_discussions\":{\"description\":\"Whether discussions are enabled.\",\"default\":false,\"type\":\"boolean\",\"example\":true},\"archived\":{\"description\":\"Whether the repository is archived.\",\"default\":false,\"type\":\"boolean\"},\"disabled\":{\"type\":\"boolean\",\"description\":\"Returns whether or not this repository disabled.\"},\"visibility\":{\"description\":\"The repository visibility: public, private, or internal.\",\"default\":\"public\",\"type\":\"string\"},\"pushed_at\":{\"type\":\"string\",\"format\":\"date-time\",\"example\":\"2011-01-26T19:06:43Z\",\"nullable\":true},\"created_at\":{\"type\":\"string\",\"format\":\"date-time\",\"example\":\"2011-01-26T19:01:12Z\",\"nullable\":true},\"updated_at\":{\"type\":\"string\",\"format\":\"date-time\",\"example\":\"2011-01-26T19:14:43Z\",\"nullable\":true},\"allow_rebase_merge\":{\"description\":\"Whether to allow rebase merges for pull requests.\",\"default\":true,\"type\":\"boolean\",\"example\":true},\"template_repository\":{\"nullable\":true,\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"integer\"},\"node_id\":{\"type\":\"string\"},\"name\":{\"type\":\"string\"},\"full_name\":{\"type\":\"string\"},\"owner\":{\"type\":\"object\",\"properties\":{\"login\":{\"type\":\"string\"},\"id\":{\"type\":\"integer\"},\"node_id\":{\"type\":\"string\"},\"avatar_url\":{\"type\":\"string\"},\"gravatar_id\":{\"type\":\"string\"},\"url\":{\"type\":\"string\"},\"html_url\":{\"type\":\"string\"},\"followers_url\":{\"type\":\"string\"},\"following_url\":{\"type\":\"string\"},\"gists_url\":{\"type\":\"string\"},\"starred_url\":{\"type\":\"string\"},\"subscriptions_url\":{\"type\":\"string\"},\"organizations_url\":{\"type\":\"string\"},\"repos_url\":{\"type\":\"string\"},\"events_url\":{\"type\":\"string\"},\"received_events_url\":{\"type\":\"string\"},\"type\":{\"type\":\"string\"},\"site_admin\":{\"type\":\"boolean\"}}},\"private\":{\"type\":\"boolean\"},\"html_url\":{\"type\":\"string\"},\"description\":{\"type\":\"string\"},\"fork\":{\"type\":\"boolean\"},\"url\":{\"type\":\"string\"},\"archive_url\":{\"type\":\"string\"},\"assignees_url\":{\"type\":\"string\"},\"blobs_url\":{\"type\":\"string\"},\"branches_url\":{\"type\":\"string\"},\"collaborators_url\":{\"type\":\"string\"},\"comments_url\":{\"type\":\"string\"},\"commits_url\":{\"type\":\"string\"},\"compare_url\":{\"type\":\"string\"},\"contents_url\":{\"type\":\"string\"},\"contributors_url\":{\"type\":\"string\"},\"deployments_url\":{\"type\":\"string\"},\"downloads_url\":{\"type\":\"string\"},\"events_url\":{\"type\":\"string\"},\"forks_url\":{\"type\":\"string\"},\"git_commits_url\":{\"type\":\"string\"},\"git_refs_url\":{\"type\":\"string\"},\"git_tags_url\":{\"type\":\"string\"},\"git_url\":{\"type\":\"string\"},\"issue_comment_url\":{\"type\":\"string\"},\"issue_events_url\":{\"type\":\"string\"},\"issues_url\":{\"type\":\"string\"},\"keys_url\":{\"type\":\"string\"},\"labels_url\":{\"type\":\"string\"},\"languages_url\":{\"type\":\"string\"},\"merges_url\":{\"type\":\"string\"},\"milestones_url\":{\"type\":\"string\"},\"notifications_url\":{\"type\":\"string\"},\"pulls_url\":{\"type\":\"string\"},\"releases_url\":{\"type\":\"string\"},\"ssh_url\":{\"type\":\"string\"},\"stargazers_url\":{\"type\":\"string\"},\"statuses_url\":{\"type\":\"string\"},\"subscribers_url\":{\"type\":\"string\"},\"subscription_url\":{\"type\":\"string\"},\"tags_url\":{\"type\":\"string\"},\"teams_url\":{\"type\":\"string\"},\"trees_url\":{\"type\":\"string\"},\"clone_url\":{\"type\":\"string\"},\"mirror_url\":{\"type\":\"string\"},\"hooks_url\":{\"type\":\"string\"},\"svn_url\":{\"type\":\"string\"},\"homepage\":{\"type\":\"string\"},\"language\":{\"type\":\"string\"},\"forks_count\":{\"type\":\"integer\"},\"stargazers_count\":{\"type\":\"integer\"},\"watchers_count\":{\"type\":\"integer\"},\"size\":{\"type\":\"integer\"},\"default_branch\":{\"type\":\"string\"},\"open_issues_count\":{\"type\":\"integer\"},\"is_template\":{\"type\":\"boolean\"},\"topics\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"has_issues\":{\"type\":\"boolean\"},\"has_projects\":{\"type\":\"boolean\"},\"has_wiki\":{\"type\":\"boolean\"},\"has_pages\":{\"type\":\"boolean\"},\"has_downloads\":{\"type\":\"boolean\"},\"archived\":{\"type\":\"boolean\"},\"disabled\":{\"type\":\"boolean\"},\"visibility\":{\"type\":\"string\"},\"pushed_at\":{\"type\":\"string\"},\"created_at\":{\"type\":\"string\"},\"updated_at\":{\"type\":\"string\"},\"permissions\":{\"type\":\"object\",\"properties\":{\"admin\":{\"type\":\"boolean\"},\"maintain\":{\"type\":\"boolean\"},\"push\":{\"type\":\"boolean\"},\"triage\":{\"type\":\"boolean\"},\"pull\":{\"type\":\"boolean\"}}},\"allow_rebase_merge\":{\"type\":\"boolean\"},\"temp_clone_token\":{\"type\":\"string\"},\"allow_squash_merge\":{\"type\":\"boolean\"},\"allow_auto_merge\":{\"type\":\"boolean\"},\"delete_branch_on_merge\":{\"type\":\"boolean\"},\"allow_update_branch\":{\"type\":\"boolean\"},\"use_squash_pr_title_as_default\":{\"type\":\"boolean\"},\"squash_merge_commit_title\":{\"type\":\"string\",\"enum\":[\"PR_TITLE\",\"COMMIT_OR_PR_TITLE\"],\"description\":\"The default value for a squash merge commit title:\\n\\n- `PR_TITLE` - default to the pull request's title.\\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).\"},\"squash_merge_commit_message\":{\"type\":\"string\",\"enum\":[\"PR_BODY\",\"COMMIT_MESSAGES\",\"BLANK\"],\"description\":\"The default value for a squash merge commit message:\\n\\n- `PR_BODY` - default to the pull request's body.\\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\\n- `BLANK` - default to a blank commit message.\"},\"merge_commit_title\":{\"type\":\"string\",\"enum\":[\"PR_TITLE\",\"MERGE_MESSAGE\"],\"description\":\"The default value for a merge commit title.\\n\\n- `PR_TITLE` - default to the pull request's title.\\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).\"},\"merge_commit_message\":{\"type\":\"string\",\"enum\":[\"PR_BODY\",\"PR_TITLE\",\"BLANK\"],\"description\":\"The default value for a merge commit message.\\n\\n- `PR_TITLE` - default to the pull request's title.\\n- `PR_BODY` - default to the pull request's body.\\n- `BLANK` - default to a blank commit message.\"},\"allow_merge_commit\":{\"type\":\"boolean\"},\"subscribers_count\":{\"type\":\"integer\"},\"network_count\":{\"type\":\"integer\"}}},\"temp_clone_token\":{\"type\":\"string\"},\"allow_squash_merge\":{\"description\":\"Whether to allow squash merges for pull requests.\",\"default\":true,\"type\":\"boolean\",\"example\":true},\"allow_auto_merge\":{\"description\":\"Whether to allow Auto-merge to be used on pull requests.\",\"default\":false,\"type\":\"boolean\",\"example\":false},\"delete_branch_on_merge\":{\"description\":\"Whether to delete head branches when pull requests are merged\",\"default\":false,\"type\":\"boolean\",\"example\":false},\"allow_update_branch\":{\"description\":\"Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.\",\"default\":false,\"type\":\"boolean\",\"example\":false},\"use_squash_pr_title_as_default\":{\"type\":\"boolean\",\"description\":\"Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.\",\"default\":false,\"deprecated\":true},\"squash_merge_commit_title\":{\"type\":\"string\",\"enum\":[\"PR_TITLE\",\"COMMIT_OR_PR_TITLE\"],\"description\":\"The default value for a squash merge commit title:\\n\\n- `PR_TITLE` - default to the pull request's title.\\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).\"},\"squash_merge_commit_message\":{\"type\":\"string\",\"enum\":[\"PR_BODY\",\"COMMIT_MESSAGES\",\"BLANK\"],\"description\":\"The default value for a squash merge commit message:\\n\\n- `PR_BODY` - default to the pull request's body.\\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\\n- `BLANK` - default to a blank commit message.\"},\"merge_commit_title\":{\"type\":\"string\",\"enum\":[\"PR_TITLE\",\"MERGE_MESSAGE\"],\"description\":\"The default value for a merge commit title.\\n\\n- `PR_TITLE` - default to the pull request's title.\\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).\"},\"merge_commit_message\":{\"type\":\"string\",\"enum\":[\"PR_BODY\",\"PR_TITLE\",\"BLANK\"],\"description\":\"The default value for a merge commit message.\\n\\n- `PR_TITLE` - default to the pull request's title.\\n- `PR_BODY` - default to the pull request's body.\\n- `BLANK` - default to a blank commit message.\"},\"allow_merge_commit\":{\"description\":\"Whether to allow merge commits for pull requests.\",\"default\":true,\"type\":\"boolean\",\"example\":true},\"allow_forking\":{\"description\":\"Whether to allow forking this repo\",\"type\":\"boolean\"},\"web_commit_signoff_required\":{\"description\":\"Whether to require contributors to sign off on web-based commits\",\"default\":false,\"type\":\"boolean\"},\"subscribers_count\":{\"type\":\"integer\"},\"network_count\":{\"type\":\"integer\"},\"open_issues\":{\"type\":\"integer\"},\"watchers\":{\"type\":\"integer\"},\"master_branch\":{\"type\":\"string\"},\"starred_at\":{\"type\":\"string\",\"example\":\"\\\"2020-07-09T00:17:42Z\\\"\"},\"anonymous_access_enabled\":{\"type\":\"boolean\",\"description\":\"Whether anonymous git access is enabled for this repository\"}},\"required\":[\"archive_url\",\"assignees_url\",\"blobs_url\",\"branches_url\",\"collaborators_url\",\"comments_url\",\"commits_url\",\"compare_url\",\"contents_url\",\"contributors_url\",\"deployments_url\",\"description\",\"downloads_url\",\"events_url\",\"fork\",\"forks_url\",\"full_name\",\"git_commits_url\",\"git_refs_url\",\"git_tags_url\",\"hooks_url\",\"html_url\",\"id\",\"node_id\",\"issue_comment_url\",\"issue_events_url\",\"issues_url\",\"keys_url\",\"labels_url\",\"languages_url\",\"merges_url\",\"milestones_url\",\"name\",\"notifications_url\",\"owner\",\"private\",\"pulls_url\",\"releases_url\",\"stargazers_url\",\"statuses_url\",\"subscribers_url\",\"subscription_url\",\"tags_url\",\"teams_url\",\"trees_url\",\"url\",\"clone_url\",\"default_branch\",\"forks\",\"forks_count\",\"git_url\",\"has_downloads\",\"has_issues\",\"has_projects\",\"has_wiki\",\"has_pages\",\"homepage\",\"language\",\"archived\",\"disabled\",\"mirror_url\",\"open_issues\",\"open_issues_count\",\"license\",\"pushed_at\",\"size\",\"ssh_url\",\"stargazers_count\",\"svn_url\",\"watchers\",\"watchers_count\",\"created_at\",\"updated_at\"]},\"performed_via_github_app\":{\"title\":\"GitHub app\",\"description\":\"GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.\",\"type\":\"object\",\"properties\":{\"id\":{\"description\":\"Unique identifier of the GitHub app\",\"example\":37,\"type\":\"integer\"},\"slug\":{\"description\":\"The slug name of the GitHub app\",\"example\":\"probot-owners\",\"type\":\"string\"},\"node_id\":{\"type\":\"string\",\"example\":\"MDExOkludGVncmF0aW9uMQ==\"},\"owner\":{\"title\":\"Simple User\",\"description\":\"A GitHub user.\",\"type\":\"object\",\"properties\":{\"name\":{\"nullable\":true,\"type\":\"string\"},\"email\":{\"nullable\":true,\"type\":\"string\"},\"login\":{\"type\":\"string\",\"example\":\"octocat\"},\"id\":{\"type\":\"integer\",\"example\":1},\"node_id\":{\"type\":\"string\",\"example\":\"MDQ6VXNlcjE=\"},\"avatar_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://github.com/images/error/octocat_happy.gif\"},\"gravatar_id\":{\"type\":\"string\",\"example\":\"41d064eb2195891e12d0413f63227ea7\",\"nullable\":true},\"url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/users/octocat\"},\"html_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://github.com/octocat\"},\"followers_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/users/octocat/followers\"},\"following_url\":{\"type\":\"string\",\"example\":\"https://api.github.com/users/octocat/following{/other_user}\"},\"gists_url\":{\"type\":\"string\",\"example\":\"https://api.github.com/users/octocat/gists{/gist_id}\"},\"starred_url\":{\"type\":\"string\",\"example\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\"},\"subscriptions_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/users/octocat/subscriptions\"},\"organizations_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/users/octocat/orgs\"},\"repos_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/users/octocat/repos\"},\"events_url\":{\"type\":\"string\",\"example\":\"https://api.github.com/users/octocat/events{/privacy}\"},\"received_events_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/users/octocat/received_events\"},\"type\":{\"type\":\"string\",\"example\":\"User\"},\"site_admin\":{\"type\":\"boolean\"},\"starred_at\":{\"type\":\"string\",\"example\":\"\\\"2020-07-09T00:17:55Z\\\"\"}},\"required\":[\"avatar_url\",\"events_url\",\"followers_url\",\"following_url\",\"gists_url\",\"gravatar_id\",\"html_url\",\"id\",\"node_id\",\"login\",\"organizations_url\",\"received_events_url\",\"repos_url\",\"site_admin\",\"starred_url\",\"subscriptions_url\",\"type\",\"url\"],\"nullable\":true},\"name\":{\"description\":\"The name of the GitHub app\",\"example\":\"Probot Owners\",\"type\":\"string\"},\"description\":{\"type\":\"string\",\"example\":\"The description of the app.\",\"nullable\":true},\"external_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://example.com\"},\"html_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://github.com/apps/super-ci\"},\"created_at\":{\"type\":\"string\",\"format\":\"date-time\",\"example\":\"2017-07-08T16:18:44-04:00\"},\"updated_at\":{\"type\":\"string\",\"format\":\"date-time\",\"example\":\"2017-07-08T16:18:44-04:00\"},\"permissions\":{\"description\":\"The set of permissions for the GitHub app\",\"type\":\"object\",\"properties\":{\"issues\":{\"type\":\"string\"},\"checks\":{\"type\":\"string\"},\"metadata\":{\"type\":\"string\"},\"contents\":{\"type\":\"string\"},\"deployments\":{\"type\":\"string\"}},\"additionalProperties\":{\"type\":\"string\"},\"example\":{\"issues\":\"read\",\"deployments\":\"write\"}},\"events\":{\"description\":\"The list of events for the GitHub app\",\"example\":[\"label\",\"deployment\"],\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"installations_count\":{\"description\":\"The number of installations associated with the GitHub app\",\"example\":5,\"type\":\"integer\"},\"client_id\":{\"type\":\"string\",\"example\":\"\\\"Iv1.25b5d1e65ffc4022\\\"\"},\"client_secret\":{\"type\":\"string\",\"example\":\"\\\"1d4b2097ac622ba702d19de498f005747a8b21d3\\\"\"},\"webhook_secret\":{\"type\":\"string\",\"example\":\"\\\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\\\"\",\"nullable\":true},\"pem\":{\"type\":\"string\",\"example\":\"\\\"-----BEGIN RSA PRIVATE KEY-----\\\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\\\n-----END RSA PRIVATE KEY-----\\\\n\\\"\"}},\"required\":[\"id\",\"node_id\",\"owner\",\"name\",\"description\",\"external_url\",\"html_url\",\"created_at\",\"updated_at\",\"permissions\",\"events\"],\"nullable\":true},\"author_association\":{\"title\":\"author_association\",\"type\":\"string\",\"example\":\"OWNER\",\"description\":\"How the author is associated with the repository.\",\"enum\":[\"COLLABORATOR\",\"CONTRIBUTOR\",\"FIRST_TIMER\",\"FIRST_TIME_CONTRIBUTOR\",\"MANNEQUIN\",\"MEMBER\",\"NONE\",\"OWNER\"]},\"reactions\":{\"title\":\"Reaction Rollup\",\"type\":\"object\",\"properties\":{\"url\":{\"type\":\"string\",\"format\":\"uri\"},\"total_count\":{\"type\":\"integer\"},\"+1\":{\"type\":\"integer\"},\"-1\":{\"type\":\"integer\"},\"laugh\":{\"type\":\"integer\"},\"confused\":{\"type\":\"integer\"},\"heart\":{\"type\":\"integer\"},\"hooray\":{\"type\":\"integer\"},\"eyes\":{\"type\":\"integer\"},\"rocket\":{\"type\":\"integer\"}},\"required\":[\"url\",\"total_count\",\"+1\",\"-1\",\"laugh\",\"confused\",\"heart\",\"hooray\",\"eyes\",\"rocket\"]}},\"required\":[\"assignee\",\"closed_at\",\"comments\",\"comments_url\",\"events_url\",\"html_url\",\"id\",\"node_id\",\"labels\",\"labels_url\",\"milestone\",\"number\",\"repository_url\",\"state\",\"locked\",\"title\",\"url\",\"user\",\"author_association\",\"created_at\",\"updated_at\"]}" }, + { + "code": 400, + "schema": "{\"title\":\"Basic Error\",\"description\":\"Basic Error\",\"type\":\"object\",\"properties\":{\"message\":{\"type\":\"string\"},\"documentation_url\":{\"type\":\"string\"},\"url\":{\"type\":\"string\"},\"status\":{\"type\":\"string\"}}}" + }, + { + "code": 400, + "schema": "{\"title\":\"Scim Error\",\"description\":\"Scim Error\",\"type\":\"object\",\"properties\":{\"message\":{\"type\":\"string\",\"nullable\":true},\"documentation_url\":{\"type\":\"string\",\"nullable\":true},\"detail\":{\"type\":\"string\",\"nullable\":true},\"status\":{\"type\":\"integer\"},\"scimType\":{\"type\":\"string\",\"nullable\":true},\"schemas\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}}}}" + }, { "code": 403, "schema": "{\"title\":\"Basic Error\",\"description\":\"Basic Error\",\"type\":\"object\",\"properties\":{\"message\":{\"type\":\"string\"},\"documentation_url\":{\"type\":\"string\"},\"url\":{\"type\":\"string\"},\"status\":{\"type\":\"string\"}}}" @@ -8800,7 +8869,7 @@ "responses": [ { "code": 200, - "schema": "{\"title\":\"Api Overview\",\"description\":\"Api Overview\",\"type\":\"object\",\"properties\":{\"verifiable_password_authentication\":{\"type\":\"boolean\",\"example\":true},\"ssh_key_fingerprints\":{\"type\":\"object\",\"properties\":{\"SHA256_RSA\":{\"type\":\"string\"},\"SHA256_DSA\":{\"type\":\"string\"},\"SHA256_ECDSA\":{\"type\":\"string\"},\"SHA256_ED25519\":{\"type\":\"string\"}}},\"ssh_keys\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"example\":[\"ssh-ed25519 ABCDEFGHIJKLMNOPQRSTUVWXYZ\"]},\"hooks\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"example\":[\"192.0.2.1\"]},\"web\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"example\":[\"192.0.2.1\"]},\"api\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"example\":[\"192.0.2.1\"]},\"git\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"example\":[\"192.0.2.1\"]},\"packages\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"example\":[\"192.0.2.1\"]},\"pages\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"example\":[\"192.0.2.1\"]},\"importer\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"example\":[\"192.0.2.1\"]},\"actions\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"example\":[\"192.0.2.1\"]},\"dependabot\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"example\":[\"192.0.2.1\"]}},\"required\":[\"verifiable_password_authentication\"]}" + "schema": "{\"title\":\"Api Overview\",\"description\":\"Api Overview\",\"type\":\"object\",\"properties\":{\"verifiable_password_authentication\":{\"type\":\"boolean\",\"example\":true},\"ssh_key_fingerprints\":{\"type\":\"object\",\"properties\":{\"SHA256_RSA\":{\"type\":\"string\"},\"SHA256_DSA\":{\"type\":\"string\"},\"SHA256_ECDSA\":{\"type\":\"string\"},\"SHA256_ED25519\":{\"type\":\"string\"}}},\"ssh_keys\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"example\":[\"ssh-ed25519 ABCDEFGHIJKLMNOPQRSTUVWXYZ\"]},\"hooks\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"example\":[\"192.0.2.1\"]},\"web\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"example\":[\"192.0.2.1\"]},\"api\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"example\":[\"192.0.2.1\"]},\"git\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"example\":[\"192.0.2.1\"]},\"packages\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"example\":[\"192.0.2.1\"]},\"pages\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"example\":[\"192.0.2.1\"]},\"importer\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"example\":[\"192.0.2.1\"]},\"actions\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"example\":[\"192.0.2.1\"]},\"dependabot\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"example\":[\"192.0.2.1\"]},\"domains\":{\"type\":\"object\",\"properties\":{\"website\":{\"type\":\"array\",\"items\":{\"type\":\"string\",\"example\":[\"example.com\"]}},\"codespaces\":{\"type\":\"array\",\"items\":{\"type\":\"string\",\"example\":[\"example.com\"]}},\"copilot\":{\"type\":\"array\",\"items\":{\"type\":\"string\",\"example\":[\"example.com\"]}},\"packages\":{\"type\":\"array\",\"items\":{\"type\":\"string\",\"example\":[\"example.com\"]}}}}},\"required\":[\"verifiable_password_authentication\"]}" }, { "code": 304, "schema": null } ], @@ -14152,7 +14221,7 @@ "responses": [ { "code": 201, - "schema": "{\"title\":\"Repository ruleset\",\"type\":\"object\",\"description\":\"A set of rules to apply when specified conditions are met.\",\"required\":[\"id\",\"name\",\"source\",\"enforcement\"],\"properties\":{\"id\":{\"type\":\"integer\",\"description\":\"The ID of the ruleset\"},\"name\":{\"type\":\"string\",\"description\":\"The name of the ruleset\"},\"target\":{\"type\":\"string\",\"description\":\"The target of the ruleset\",\"enum\":[\"branch\",\"tag\"]},\"source_type\":{\"type\":\"string\",\"description\":\"The type of the source of the ruleset\",\"enum\":[\"Repository\",\"Organization\"]},\"source\":{\"type\":\"string\",\"description\":\"The name of the source\"},\"enforcement\":{\"type\":\"string\",\"description\":\"The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise).\",\"enum\":[\"disabled\",\"active\",\"evaluate\"]},\"bypass_mode\":{\"type\":\"string\",\"description\":\"The permission level required to bypass this ruleset. \\\"repository\\\" allows those with bypass permission at the repository level to bypass. \\\"organization\\\" allows those with bypass permission at the organization level to bypass. \\\"none\\\" prevents anyone from bypassing.\",\"enum\":[\"none\",\"repository\",\"organization\"]},\"bypass_actors\":{\"type\":\"array\",\"description\":\"The actors that can bypass the rules in this ruleset\",\"items\":{\"title\":\"Repository Ruleset Bypass Actor\",\"type\":\"object\",\"description\":\"An actor that can bypass rules in a ruleset\",\"properties\":{\"actor_id\":{\"type\":\"integer\",\"description\":\"The ID of the actor that can bypass a ruleset\"},\"actor_type\":{\"type\":\"string\",\"enum\":[\"Team\",\"Integration\"],\"description\":\"The type of actor that can bypass a ruleset\"}}}},\"node_id\":{\"type\":\"string\"},\"_links\":{\"type\":\"object\",\"properties\":{\"self\":{\"type\":\"object\",\"properties\":{\"href\":{\"type\":\"string\",\"description\":\"The URL of the ruleset\"}}}}},\"conditions\":{\"anyOf\":[{\"title\":\"Repository ruleset conditions for ref names\",\"type\":\"object\",\"description\":\"Parameters for a repository ruleset ref name condition\",\"properties\":{\"ref_name\":{\"type\":\"object\",\"properties\":{\"include\":{\"type\":\"array\",\"description\":\"Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.\",\"items\":{\"type\":\"string\"}},\"exclude\":{\"type\":\"array\",\"description\":\"Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.\",\"items\":{\"type\":\"string\"}}}}}},{\"title\":\"Organization ruleset conditions\",\"type\":\"object\",\"description\":\"Conditions for a organization ruleset\",\"allOf\":[{\"title\":\"Repository ruleset conditions for ref names\",\"type\":\"object\",\"description\":\"Parameters for a repository ruleset ref name condition\",\"properties\":{\"ref_name\":{\"type\":\"object\",\"properties\":{\"include\":{\"type\":\"array\",\"description\":\"Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.\",\"items\":{\"type\":\"string\"}},\"exclude\":{\"type\":\"array\",\"description\":\"Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.\",\"items\":{\"type\":\"string\"}}}}}},{\"title\":\"Repository ruleset conditions for repository names\",\"type\":\"object\",\"description\":\"Parameters for a repository name condition\",\"properties\":{\"repository_name\":{\"type\":\"object\",\"properties\":{\"include\":{\"type\":\"array\",\"description\":\"Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.\",\"items\":{\"type\":\"string\"}},\"exclude\":{\"type\":\"array\",\"description\":\"Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.\",\"items\":{\"type\":\"string\"}},\"protected\":{\"type\":\"boolean\",\"description\":\"Whether renaming of target repositories is prevented.\"}}}}}]}]},\"rules\":{\"type\":\"array\",\"items\":{\"title\":\"Repository Rule\",\"type\":\"object\",\"description\":\"A repository rule.\",\"oneOf\":[{\"title\":\"creation\",\"description\":\"Parameters to be used for the creation rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"creation\"]}}},{\"title\":\"update\",\"description\":\"Parameters to be used for the update rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"update\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"update_allows_fetch_and_merge\":{\"type\":\"boolean\",\"description\":\"Branch can pull changes from its upstream repository\"}},\"required\":[\"update_allows_fetch_and_merge\"]}}},{\"title\":\"deletion\",\"description\":\"Parameters to be used for the deletion rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"deletion\"]}}},{\"title\":\"required_linear_history\",\"description\":\"Parameters to be used for the required_linear_history rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"required_linear_history\"]}}},{\"title\":\"required_deployments\",\"description\":\"Parameters to be used for the required_deployments rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"required_deployments\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"required_deployment_environments\":{\"type\":\"array\",\"description\":\"The environments that must be successfully deployed to before branches can be merged.\",\"items\":{\"type\":\"string\"}}},\"required\":[\"required_deployment_environments\"]}}},{\"title\":\"required_signatures\",\"description\":\"Parameters to be used for the required_signatures rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"required_signatures\"]}}},{\"title\":\"pull_request\",\"description\":\"Parameters to be used for the pull_request rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"pull_request\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"dismiss_stale_reviews_on_push\":{\"type\":\"boolean\",\"description\":\"New, reviewable commits pushed will dismiss previous pull request review approvals.\"},\"require_code_owner_review\":{\"type\":\"boolean\",\"description\":\"Require an approving review in pull requests that modify files that have a designated code owner.\"},\"require_last_push_approval\":{\"type\":\"boolean\",\"description\":\"Whether the most recent reviewable push must be approved by someone other than the person who pushed it.\"},\"required_approving_review_count\":{\"type\":\"integer\",\"description\":\"The number of approving reviews that are required before a pull request can be merged.\",\"minimum\":0,\"maximum\":10},\"required_review_thread_resolution\":{\"type\":\"boolean\",\"description\":\"All conversations on code must be resolved before a pull request can be merged.\"}},\"required\":[\"dismiss_stale_reviews_on_push\",\"require_code_owner_review\",\"require_last_push_approval\",\"required_approving_review_count\",\"required_review_thread_resolution\"]}}},{\"title\":\"required_status_checks\",\"description\":\"Parameters to be used for the required_status_checks rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"required_status_checks\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"required_status_checks\":{\"type\":\"array\",\"description\":\"Status checks that are required.\",\"items\":{\"title\":\"StatusCheckConfiguration\",\"description\":\"Required status check\",\"type\":\"object\",\"properties\":{\"context\":{\"type\":\"string\",\"description\":\"The status check context name that must be present on the commit.\"},\"integration_id\":{\"type\":\"integer\",\"description\":\"The optional integration ID that this status check must originate from.\"}},\"required\":[\"context\"]}},\"strict_required_status_checks_policy\":{\"type\":\"boolean\",\"description\":\"Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled.\"}},\"required\":[\"required_status_checks\",\"strict_required_status_checks_policy\"]}}},{\"title\":\"non_fast_forward\",\"description\":\"Parameters to be used for the non_fast_forward rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"non_fast_forward\"]}}},{\"title\":\"commit_message_pattern\",\"description\":\"Parameters to be used for the commit_message_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"commit_message_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}},{\"title\":\"commit_author_email_pattern\",\"description\":\"Parameters to be used for the commit_author_email_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"commit_author_email_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}},{\"title\":\"committer_email_pattern\",\"description\":\"Parameters to be used for the committer_email_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"committer_email_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}},{\"title\":\"branch_name_pattern\",\"description\":\"Parameters to be used for the branch_name_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"branch_name_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}},{\"title\":\"tag_name_pattern\",\"description\":\"Parameters to be used for the tag_name_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"tag_name_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}}]}}}}" + "schema": "{\"title\":\"Repository ruleset\",\"type\":\"object\",\"description\":\"A set of rules to apply when specified conditions are met.\",\"required\":[\"id\",\"name\",\"source\",\"enforcement\"],\"properties\":{\"id\":{\"type\":\"integer\",\"description\":\"The ID of the ruleset\"},\"name\":{\"type\":\"string\",\"description\":\"The name of the ruleset\"},\"target\":{\"type\":\"string\",\"description\":\"The target of the ruleset\",\"enum\":[\"branch\",\"tag\"]},\"source_type\":{\"type\":\"string\",\"description\":\"The type of the source of the ruleset\",\"enum\":[\"Repository\",\"Organization\"]},\"source\":{\"type\":\"string\",\"description\":\"The name of the source\"},\"enforcement\":{\"type\":\"string\",\"description\":\"The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise).\",\"enum\":[\"disabled\",\"active\",\"evaluate\"]},\"bypass_mode\":{\"type\":\"string\",\"description\":\"The permission level required to bypass this ruleset. \\\"repository\\\" allows those with bypass permission at the repository level to bypass. \\\"organization\\\" allows those with bypass permission at the organization level to bypass. \\\"none\\\" prevents anyone from bypassing.\",\"enum\":[\"none\",\"repository\",\"organization\"]},\"bypass_actors\":{\"type\":\"array\",\"description\":\"The actors that can bypass the rules in this ruleset\",\"items\":{\"title\":\"Repository Ruleset Bypass Actor\",\"type\":\"object\",\"description\":\"An actor that can bypass rules in a ruleset\",\"properties\":{\"actor_id\":{\"type\":\"integer\",\"description\":\"The ID of the actor that can bypass a ruleset\"},\"actor_type\":{\"type\":\"string\",\"enum\":[\"Team\",\"Integration\"],\"description\":\"The type of actor that can bypass a ruleset\"}}}},\"node_id\":{\"type\":\"string\"},\"_links\":{\"type\":\"object\",\"properties\":{\"self\":{\"type\":\"object\",\"properties\":{\"href\":{\"type\":\"string\",\"description\":\"The URL of the ruleset\"}}},\"html\":{\"type\":\"object\",\"properties\":{\"href\":{\"type\":\"string\",\"description\":\"The html URL of the ruleset\"}}}}},\"conditions\":{\"anyOf\":[{\"title\":\"Repository ruleset conditions for ref names\",\"type\":\"object\",\"description\":\"Parameters for a repository ruleset ref name condition\",\"properties\":{\"ref_name\":{\"type\":\"object\",\"properties\":{\"include\":{\"type\":\"array\",\"description\":\"Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.\",\"items\":{\"type\":\"string\"}},\"exclude\":{\"type\":\"array\",\"description\":\"Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.\",\"items\":{\"type\":\"string\"}}}}}},{\"title\":\"Organization ruleset conditions\",\"type\":\"object\",\"description\":\"Conditions for a organization ruleset\",\"allOf\":[{\"title\":\"Repository ruleset conditions for ref names\",\"type\":\"object\",\"description\":\"Parameters for a repository ruleset ref name condition\",\"properties\":{\"ref_name\":{\"type\":\"object\",\"properties\":{\"include\":{\"type\":\"array\",\"description\":\"Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.\",\"items\":{\"type\":\"string\"}},\"exclude\":{\"type\":\"array\",\"description\":\"Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.\",\"items\":{\"type\":\"string\"}}}}}},{\"title\":\"Repository ruleset conditions for repository names\",\"type\":\"object\",\"description\":\"Parameters for a repository name condition\",\"properties\":{\"repository_name\":{\"type\":\"object\",\"properties\":{\"include\":{\"type\":\"array\",\"description\":\"Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.\",\"items\":{\"type\":\"string\"}},\"exclude\":{\"type\":\"array\",\"description\":\"Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.\",\"items\":{\"type\":\"string\"}},\"protected\":{\"type\":\"boolean\",\"description\":\"Whether renaming of target repositories is prevented.\"}}}}}]}]},\"rules\":{\"type\":\"array\",\"items\":{\"title\":\"Repository Rule\",\"type\":\"object\",\"description\":\"A repository rule.\",\"oneOf\":[{\"title\":\"creation\",\"description\":\"Only allow users with bypass permission to create matching refs.\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"creation\"]}}},{\"title\":\"update\",\"description\":\"Only allow users with bypass permission to update matching refs.\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"update\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"update_allows_fetch_and_merge\":{\"type\":\"boolean\",\"description\":\"Branch can pull changes from its upstream repository\"}},\"required\":[\"update_allows_fetch_and_merge\"]}}},{\"title\":\"deletion\",\"description\":\"Only allow users with bypass permissions to delete matching refs.\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"deletion\"]}}},{\"title\":\"required_linear_history\",\"description\":\"Prevent merge commits from being pushed to matching branches.\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"required_linear_history\"]}}},{\"title\":\"required_deployments\",\"description\":\"Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule.\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"required_deployments\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"required_deployment_environments\":{\"type\":\"array\",\"description\":\"The environments that must be successfully deployed to before branches can be merged.\",\"items\":{\"type\":\"string\"}}},\"required\":[\"required_deployment_environments\"]}}},{\"title\":\"required_signatures\",\"description\":\"Commits pushed to matching branches must have verified signatures.\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"required_signatures\"]}}},{\"title\":\"pull_request\",\"description\":\"Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"pull_request\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"dismiss_stale_reviews_on_push\":{\"type\":\"boolean\",\"description\":\"New, reviewable commits pushed will dismiss previous pull request review approvals.\"},\"require_code_owner_review\":{\"type\":\"boolean\",\"description\":\"Require an approving review in pull requests that modify files that have a designated code owner.\"},\"require_last_push_approval\":{\"type\":\"boolean\",\"description\":\"Whether the most recent reviewable push must be approved by someone other than the person who pushed it.\"},\"required_approving_review_count\":{\"type\":\"integer\",\"description\":\"The number of approving reviews that are required before a pull request can be merged.\",\"minimum\":0,\"maximum\":10},\"required_review_thread_resolution\":{\"type\":\"boolean\",\"description\":\"All conversations on code must be resolved before a pull request can be merged.\"}},\"required\":[\"dismiss_stale_reviews_on_push\",\"require_code_owner_review\",\"require_last_push_approval\",\"required_approving_review_count\",\"required_review_thread_resolution\"]}}},{\"title\":\"required_status_checks\",\"description\":\"Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"required_status_checks\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"required_status_checks\":{\"type\":\"array\",\"description\":\"Status checks that are required.\",\"items\":{\"title\":\"StatusCheckConfiguration\",\"description\":\"Required status check\",\"type\":\"object\",\"properties\":{\"context\":{\"type\":\"string\",\"description\":\"The status check context name that must be present on the commit.\"},\"integration_id\":{\"type\":\"integer\",\"description\":\"The optional integration ID that this status check must originate from.\"}},\"required\":[\"context\"]}},\"strict_required_status_checks_policy\":{\"type\":\"boolean\",\"description\":\"Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled.\"}},\"required\":[\"required_status_checks\",\"strict_required_status_checks_policy\"]}}},{\"title\":\"non_fast_forward\",\"description\":\"Prevent users with push access from force pushing to branches.\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"non_fast_forward\"]}}},{\"title\":\"commit_message_pattern\",\"description\":\"Parameters to be used for the commit_message_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"commit_message_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}},{\"title\":\"commit_author_email_pattern\",\"description\":\"Parameters to be used for the commit_author_email_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"commit_author_email_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}},{\"title\":\"committer_email_pattern\",\"description\":\"Parameters to be used for the committer_email_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"committer_email_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}},{\"title\":\"branch_name_pattern\",\"description\":\"Parameters to be used for the branch_name_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"branch_name_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}},{\"title\":\"tag_name_pattern\",\"description\":\"Parameters to be used for the tag_name_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"tag_name_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}}]}},\"created_at\":{\"type\":\"string\",\"format\":\"date-time\"},\"updated_at\":{\"type\":\"string\",\"format\":\"date-time\"}}}" }, { "code": 404, @@ -14301,7 +14370,7 @@ "responses": [ { "code": 201, - "schema": "{\"title\":\"Repository ruleset\",\"type\":\"object\",\"description\":\"A set of rules to apply when specified conditions are met.\",\"required\":[\"id\",\"name\",\"source\",\"enforcement\"],\"properties\":{\"id\":{\"type\":\"integer\",\"description\":\"The ID of the ruleset\"},\"name\":{\"type\":\"string\",\"description\":\"The name of the ruleset\"},\"target\":{\"type\":\"string\",\"description\":\"The target of the ruleset\",\"enum\":[\"branch\",\"tag\"]},\"source_type\":{\"type\":\"string\",\"description\":\"The type of the source of the ruleset\",\"enum\":[\"Repository\",\"Organization\"]},\"source\":{\"type\":\"string\",\"description\":\"The name of the source\"},\"enforcement\":{\"type\":\"string\",\"description\":\"The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise).\",\"enum\":[\"disabled\",\"active\",\"evaluate\"]},\"bypass_mode\":{\"type\":\"string\",\"description\":\"The permission level required to bypass this ruleset. \\\"repository\\\" allows those with bypass permission at the repository level to bypass. \\\"organization\\\" allows those with bypass permission at the organization level to bypass. \\\"none\\\" prevents anyone from bypassing.\",\"enum\":[\"none\",\"repository\",\"organization\"]},\"bypass_actors\":{\"type\":\"array\",\"description\":\"The actors that can bypass the rules in this ruleset\",\"items\":{\"title\":\"Repository Ruleset Bypass Actor\",\"type\":\"object\",\"description\":\"An actor that can bypass rules in a ruleset\",\"properties\":{\"actor_id\":{\"type\":\"integer\",\"description\":\"The ID of the actor that can bypass a ruleset\"},\"actor_type\":{\"type\":\"string\",\"enum\":[\"Team\",\"Integration\"],\"description\":\"The type of actor that can bypass a ruleset\"}}}},\"node_id\":{\"type\":\"string\"},\"_links\":{\"type\":\"object\",\"properties\":{\"self\":{\"type\":\"object\",\"properties\":{\"href\":{\"type\":\"string\",\"description\":\"The URL of the ruleset\"}}}}},\"conditions\":{\"anyOf\":[{\"title\":\"Repository ruleset conditions for ref names\",\"type\":\"object\",\"description\":\"Parameters for a repository ruleset ref name condition\",\"properties\":{\"ref_name\":{\"type\":\"object\",\"properties\":{\"include\":{\"type\":\"array\",\"description\":\"Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.\",\"items\":{\"type\":\"string\"}},\"exclude\":{\"type\":\"array\",\"description\":\"Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.\",\"items\":{\"type\":\"string\"}}}}}},{\"title\":\"Organization ruleset conditions\",\"type\":\"object\",\"description\":\"Conditions for a organization ruleset\",\"allOf\":[{\"title\":\"Repository ruleset conditions for ref names\",\"type\":\"object\",\"description\":\"Parameters for a repository ruleset ref name condition\",\"properties\":{\"ref_name\":{\"type\":\"object\",\"properties\":{\"include\":{\"type\":\"array\",\"description\":\"Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.\",\"items\":{\"type\":\"string\"}},\"exclude\":{\"type\":\"array\",\"description\":\"Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.\",\"items\":{\"type\":\"string\"}}}}}},{\"title\":\"Repository ruleset conditions for repository names\",\"type\":\"object\",\"description\":\"Parameters for a repository name condition\",\"properties\":{\"repository_name\":{\"type\":\"object\",\"properties\":{\"include\":{\"type\":\"array\",\"description\":\"Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.\",\"items\":{\"type\":\"string\"}},\"exclude\":{\"type\":\"array\",\"description\":\"Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.\",\"items\":{\"type\":\"string\"}},\"protected\":{\"type\":\"boolean\",\"description\":\"Whether renaming of target repositories is prevented.\"}}}}}]}]},\"rules\":{\"type\":\"array\",\"items\":{\"title\":\"Repository Rule\",\"type\":\"object\",\"description\":\"A repository rule.\",\"oneOf\":[{\"title\":\"creation\",\"description\":\"Parameters to be used for the creation rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"creation\"]}}},{\"title\":\"update\",\"description\":\"Parameters to be used for the update rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"update\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"update_allows_fetch_and_merge\":{\"type\":\"boolean\",\"description\":\"Branch can pull changes from its upstream repository\"}},\"required\":[\"update_allows_fetch_and_merge\"]}}},{\"title\":\"deletion\",\"description\":\"Parameters to be used for the deletion rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"deletion\"]}}},{\"title\":\"required_linear_history\",\"description\":\"Parameters to be used for the required_linear_history rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"required_linear_history\"]}}},{\"title\":\"required_deployments\",\"description\":\"Parameters to be used for the required_deployments rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"required_deployments\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"required_deployment_environments\":{\"type\":\"array\",\"description\":\"The environments that must be successfully deployed to before branches can be merged.\",\"items\":{\"type\":\"string\"}}},\"required\":[\"required_deployment_environments\"]}}},{\"title\":\"required_signatures\",\"description\":\"Parameters to be used for the required_signatures rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"required_signatures\"]}}},{\"title\":\"pull_request\",\"description\":\"Parameters to be used for the pull_request rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"pull_request\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"dismiss_stale_reviews_on_push\":{\"type\":\"boolean\",\"description\":\"New, reviewable commits pushed will dismiss previous pull request review approvals.\"},\"require_code_owner_review\":{\"type\":\"boolean\",\"description\":\"Require an approving review in pull requests that modify files that have a designated code owner.\"},\"require_last_push_approval\":{\"type\":\"boolean\",\"description\":\"Whether the most recent reviewable push must be approved by someone other than the person who pushed it.\"},\"required_approving_review_count\":{\"type\":\"integer\",\"description\":\"The number of approving reviews that are required before a pull request can be merged.\",\"minimum\":0,\"maximum\":10},\"required_review_thread_resolution\":{\"type\":\"boolean\",\"description\":\"All conversations on code must be resolved before a pull request can be merged.\"}},\"required\":[\"dismiss_stale_reviews_on_push\",\"require_code_owner_review\",\"require_last_push_approval\",\"required_approving_review_count\",\"required_review_thread_resolution\"]}}},{\"title\":\"required_status_checks\",\"description\":\"Parameters to be used for the required_status_checks rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"required_status_checks\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"required_status_checks\":{\"type\":\"array\",\"description\":\"Status checks that are required.\",\"items\":{\"title\":\"StatusCheckConfiguration\",\"description\":\"Required status check\",\"type\":\"object\",\"properties\":{\"context\":{\"type\":\"string\",\"description\":\"The status check context name that must be present on the commit.\"},\"integration_id\":{\"type\":\"integer\",\"description\":\"The optional integration ID that this status check must originate from.\"}},\"required\":[\"context\"]}},\"strict_required_status_checks_policy\":{\"type\":\"boolean\",\"description\":\"Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled.\"}},\"required\":[\"required_status_checks\",\"strict_required_status_checks_policy\"]}}},{\"title\":\"non_fast_forward\",\"description\":\"Parameters to be used for the non_fast_forward rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"non_fast_forward\"]}}},{\"title\":\"commit_message_pattern\",\"description\":\"Parameters to be used for the commit_message_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"commit_message_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}},{\"title\":\"commit_author_email_pattern\",\"description\":\"Parameters to be used for the commit_author_email_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"commit_author_email_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}},{\"title\":\"committer_email_pattern\",\"description\":\"Parameters to be used for the committer_email_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"committer_email_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}},{\"title\":\"branch_name_pattern\",\"description\":\"Parameters to be used for the branch_name_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"branch_name_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}},{\"title\":\"tag_name_pattern\",\"description\":\"Parameters to be used for the tag_name_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"tag_name_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}}]}}}}" + "schema": "{\"title\":\"Repository ruleset\",\"type\":\"object\",\"description\":\"A set of rules to apply when specified conditions are met.\",\"required\":[\"id\",\"name\",\"source\",\"enforcement\"],\"properties\":{\"id\":{\"type\":\"integer\",\"description\":\"The ID of the ruleset\"},\"name\":{\"type\":\"string\",\"description\":\"The name of the ruleset\"},\"target\":{\"type\":\"string\",\"description\":\"The target of the ruleset\",\"enum\":[\"branch\",\"tag\"]},\"source_type\":{\"type\":\"string\",\"description\":\"The type of the source of the ruleset\",\"enum\":[\"Repository\",\"Organization\"]},\"source\":{\"type\":\"string\",\"description\":\"The name of the source\"},\"enforcement\":{\"type\":\"string\",\"description\":\"The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise).\",\"enum\":[\"disabled\",\"active\",\"evaluate\"]},\"bypass_mode\":{\"type\":\"string\",\"description\":\"The permission level required to bypass this ruleset. \\\"repository\\\" allows those with bypass permission at the repository level to bypass. \\\"organization\\\" allows those with bypass permission at the organization level to bypass. \\\"none\\\" prevents anyone from bypassing.\",\"enum\":[\"none\",\"repository\",\"organization\"]},\"bypass_actors\":{\"type\":\"array\",\"description\":\"The actors that can bypass the rules in this ruleset\",\"items\":{\"title\":\"Repository Ruleset Bypass Actor\",\"type\":\"object\",\"description\":\"An actor that can bypass rules in a ruleset\",\"properties\":{\"actor_id\":{\"type\":\"integer\",\"description\":\"The ID of the actor that can bypass a ruleset\"},\"actor_type\":{\"type\":\"string\",\"enum\":[\"Team\",\"Integration\"],\"description\":\"The type of actor that can bypass a ruleset\"}}}},\"node_id\":{\"type\":\"string\"},\"_links\":{\"type\":\"object\",\"properties\":{\"self\":{\"type\":\"object\",\"properties\":{\"href\":{\"type\":\"string\",\"description\":\"The URL of the ruleset\"}}},\"html\":{\"type\":\"object\",\"properties\":{\"href\":{\"type\":\"string\",\"description\":\"The html URL of the ruleset\"}}}}},\"conditions\":{\"anyOf\":[{\"title\":\"Repository ruleset conditions for ref names\",\"type\":\"object\",\"description\":\"Parameters for a repository ruleset ref name condition\",\"properties\":{\"ref_name\":{\"type\":\"object\",\"properties\":{\"include\":{\"type\":\"array\",\"description\":\"Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.\",\"items\":{\"type\":\"string\"}},\"exclude\":{\"type\":\"array\",\"description\":\"Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.\",\"items\":{\"type\":\"string\"}}}}}},{\"title\":\"Organization ruleset conditions\",\"type\":\"object\",\"description\":\"Conditions for a organization ruleset\",\"allOf\":[{\"title\":\"Repository ruleset conditions for ref names\",\"type\":\"object\",\"description\":\"Parameters for a repository ruleset ref name condition\",\"properties\":{\"ref_name\":{\"type\":\"object\",\"properties\":{\"include\":{\"type\":\"array\",\"description\":\"Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.\",\"items\":{\"type\":\"string\"}},\"exclude\":{\"type\":\"array\",\"description\":\"Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.\",\"items\":{\"type\":\"string\"}}}}}},{\"title\":\"Repository ruleset conditions for repository names\",\"type\":\"object\",\"description\":\"Parameters for a repository name condition\",\"properties\":{\"repository_name\":{\"type\":\"object\",\"properties\":{\"include\":{\"type\":\"array\",\"description\":\"Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.\",\"items\":{\"type\":\"string\"}},\"exclude\":{\"type\":\"array\",\"description\":\"Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.\",\"items\":{\"type\":\"string\"}},\"protected\":{\"type\":\"boolean\",\"description\":\"Whether renaming of target repositories is prevented.\"}}}}}]}]},\"rules\":{\"type\":\"array\",\"items\":{\"title\":\"Repository Rule\",\"type\":\"object\",\"description\":\"A repository rule.\",\"oneOf\":[{\"title\":\"creation\",\"description\":\"Only allow users with bypass permission to create matching refs.\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"creation\"]}}},{\"title\":\"update\",\"description\":\"Only allow users with bypass permission to update matching refs.\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"update\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"update_allows_fetch_and_merge\":{\"type\":\"boolean\",\"description\":\"Branch can pull changes from its upstream repository\"}},\"required\":[\"update_allows_fetch_and_merge\"]}}},{\"title\":\"deletion\",\"description\":\"Only allow users with bypass permissions to delete matching refs.\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"deletion\"]}}},{\"title\":\"required_linear_history\",\"description\":\"Prevent merge commits from being pushed to matching branches.\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"required_linear_history\"]}}},{\"title\":\"required_deployments\",\"description\":\"Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule.\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"required_deployments\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"required_deployment_environments\":{\"type\":\"array\",\"description\":\"The environments that must be successfully deployed to before branches can be merged.\",\"items\":{\"type\":\"string\"}}},\"required\":[\"required_deployment_environments\"]}}},{\"title\":\"required_signatures\",\"description\":\"Commits pushed to matching branches must have verified signatures.\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"required_signatures\"]}}},{\"title\":\"pull_request\",\"description\":\"Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"pull_request\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"dismiss_stale_reviews_on_push\":{\"type\":\"boolean\",\"description\":\"New, reviewable commits pushed will dismiss previous pull request review approvals.\"},\"require_code_owner_review\":{\"type\":\"boolean\",\"description\":\"Require an approving review in pull requests that modify files that have a designated code owner.\"},\"require_last_push_approval\":{\"type\":\"boolean\",\"description\":\"Whether the most recent reviewable push must be approved by someone other than the person who pushed it.\"},\"required_approving_review_count\":{\"type\":\"integer\",\"description\":\"The number of approving reviews that are required before a pull request can be merged.\",\"minimum\":0,\"maximum\":10},\"required_review_thread_resolution\":{\"type\":\"boolean\",\"description\":\"All conversations on code must be resolved before a pull request can be merged.\"}},\"required\":[\"dismiss_stale_reviews_on_push\",\"require_code_owner_review\",\"require_last_push_approval\",\"required_approving_review_count\",\"required_review_thread_resolution\"]}}},{\"title\":\"required_status_checks\",\"description\":\"Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"required_status_checks\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"required_status_checks\":{\"type\":\"array\",\"description\":\"Status checks that are required.\",\"items\":{\"title\":\"StatusCheckConfiguration\",\"description\":\"Required status check\",\"type\":\"object\",\"properties\":{\"context\":{\"type\":\"string\",\"description\":\"The status check context name that must be present on the commit.\"},\"integration_id\":{\"type\":\"integer\",\"description\":\"The optional integration ID that this status check must originate from.\"}},\"required\":[\"context\"]}},\"strict_required_status_checks_policy\":{\"type\":\"boolean\",\"description\":\"Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled.\"}},\"required\":[\"required_status_checks\",\"strict_required_status_checks_policy\"]}}},{\"title\":\"non_fast_forward\",\"description\":\"Prevent users with push access from force pushing to branches.\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"non_fast_forward\"]}}},{\"title\":\"commit_message_pattern\",\"description\":\"Parameters to be used for the commit_message_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"commit_message_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}},{\"title\":\"commit_author_email_pattern\",\"description\":\"Parameters to be used for the commit_author_email_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"commit_author_email_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}},{\"title\":\"committer_email_pattern\",\"description\":\"Parameters to be used for the committer_email_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"committer_email_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}},{\"title\":\"branch_name_pattern\",\"description\":\"Parameters to be used for the branch_name_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"branch_name_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}},{\"title\":\"tag_name_pattern\",\"description\":\"Parameters to be used for the tag_name_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"tag_name_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}}]}},\"created_at\":{\"type\":\"string\",\"format\":\"date-time\"},\"updated_at\":{\"type\":\"string\",\"format\":\"date-time\"}}}" }, { "code": 404, @@ -15264,13 +15333,15 @@ "responses": [ { "code": 200, - "schema": "{\"type\":\"array\",\"items\":{\"title\":\"Repository Rule\",\"type\":\"object\",\"description\":\"A repository rule.\",\"oneOf\":[{\"title\":\"creation\",\"description\":\"Parameters to be used for the creation rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"creation\"]}}},{\"title\":\"update\",\"description\":\"Parameters to be used for the update rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"update\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"update_allows_fetch_and_merge\":{\"type\":\"boolean\",\"description\":\"Branch can pull changes from its upstream repository\"}},\"required\":[\"update_allows_fetch_and_merge\"]}}},{\"title\":\"deletion\",\"description\":\"Parameters to be used for the deletion rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"deletion\"]}}},{\"title\":\"required_linear_history\",\"description\":\"Parameters to be used for the required_linear_history rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"required_linear_history\"]}}},{\"title\":\"required_deployments\",\"description\":\"Parameters to be used for the required_deployments rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"required_deployments\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"required_deployment_environments\":{\"type\":\"array\",\"description\":\"The environments that must be successfully deployed to before branches can be merged.\",\"items\":{\"type\":\"string\"}}},\"required\":[\"required_deployment_environments\"]}}},{\"title\":\"required_signatures\",\"description\":\"Parameters to be used for the required_signatures rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"required_signatures\"]}}},{\"title\":\"pull_request\",\"description\":\"Parameters to be used for the pull_request rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"pull_request\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"dismiss_stale_reviews_on_push\":{\"type\":\"boolean\",\"description\":\"New, reviewable commits pushed will dismiss previous pull request review approvals.\"},\"require_code_owner_review\":{\"type\":\"boolean\",\"description\":\"Require an approving review in pull requests that modify files that have a designated code owner.\"},\"require_last_push_approval\":{\"type\":\"boolean\",\"description\":\"Whether the most recent reviewable push must be approved by someone other than the person who pushed it.\"},\"required_approving_review_count\":{\"type\":\"integer\",\"description\":\"The number of approving reviews that are required before a pull request can be merged.\",\"minimum\":0,\"maximum\":10},\"required_review_thread_resolution\":{\"type\":\"boolean\",\"description\":\"All conversations on code must be resolved before a pull request can be merged.\"}},\"required\":[\"dismiss_stale_reviews_on_push\",\"require_code_owner_review\",\"require_last_push_approval\",\"required_approving_review_count\",\"required_review_thread_resolution\"]}}},{\"title\":\"required_status_checks\",\"description\":\"Parameters to be used for the required_status_checks rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"required_status_checks\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"required_status_checks\":{\"type\":\"array\",\"description\":\"Status checks that are required.\",\"items\":{\"title\":\"StatusCheckConfiguration\",\"description\":\"Required status check\",\"type\":\"object\",\"properties\":{\"context\":{\"type\":\"string\",\"description\":\"The status check context name that must be present on the commit.\"},\"integration_id\":{\"type\":\"integer\",\"description\":\"The optional integration ID that this status check must originate from.\"}},\"required\":[\"context\"]}},\"strict_required_status_checks_policy\":{\"type\":\"boolean\",\"description\":\"Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled.\"}},\"required\":[\"required_status_checks\",\"strict_required_status_checks_policy\"]}}},{\"title\":\"non_fast_forward\",\"description\":\"Parameters to be used for the non_fast_forward rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"non_fast_forward\"]}}},{\"title\":\"commit_message_pattern\",\"description\":\"Parameters to be used for the commit_message_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"commit_message_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}},{\"title\":\"commit_author_email_pattern\",\"description\":\"Parameters to be used for the commit_author_email_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"commit_author_email_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}},{\"title\":\"committer_email_pattern\",\"description\":\"Parameters to be used for the committer_email_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"committer_email_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}},{\"title\":\"branch_name_pattern\",\"description\":\"Parameters to be used for the branch_name_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"branch_name_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}},{\"title\":\"tag_name_pattern\",\"description\":\"Parameters to be used for the tag_name_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"tag_name_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}}]}}" + "schema": "{\"type\":\"array\",\"items\":{\"title\":\"Repository Rule\",\"type\":\"object\",\"description\":\"A repository rule.\",\"oneOf\":[{\"title\":\"creation\",\"description\":\"Only allow users with bypass permission to create matching refs.\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"creation\"]}}},{\"title\":\"update\",\"description\":\"Only allow users with bypass permission to update matching refs.\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"update\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"update_allows_fetch_and_merge\":{\"type\":\"boolean\",\"description\":\"Branch can pull changes from its upstream repository\"}},\"required\":[\"update_allows_fetch_and_merge\"]}}},{\"title\":\"deletion\",\"description\":\"Only allow users with bypass permissions to delete matching refs.\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"deletion\"]}}},{\"title\":\"required_linear_history\",\"description\":\"Prevent merge commits from being pushed to matching branches.\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"required_linear_history\"]}}},{\"title\":\"required_deployments\",\"description\":\"Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule.\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"required_deployments\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"required_deployment_environments\":{\"type\":\"array\",\"description\":\"The environments that must be successfully deployed to before branches can be merged.\",\"items\":{\"type\":\"string\"}}},\"required\":[\"required_deployment_environments\"]}}},{\"title\":\"required_signatures\",\"description\":\"Commits pushed to matching branches must have verified signatures.\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"required_signatures\"]}}},{\"title\":\"pull_request\",\"description\":\"Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"pull_request\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"dismiss_stale_reviews_on_push\":{\"type\":\"boolean\",\"description\":\"New, reviewable commits pushed will dismiss previous pull request review approvals.\"},\"require_code_owner_review\":{\"type\":\"boolean\",\"description\":\"Require an approving review in pull requests that modify files that have a designated code owner.\"},\"require_last_push_approval\":{\"type\":\"boolean\",\"description\":\"Whether the most recent reviewable push must be approved by someone other than the person who pushed it.\"},\"required_approving_review_count\":{\"type\":\"integer\",\"description\":\"The number of approving reviews that are required before a pull request can be merged.\",\"minimum\":0,\"maximum\":10},\"required_review_thread_resolution\":{\"type\":\"boolean\",\"description\":\"All conversations on code must be resolved before a pull request can be merged.\"}},\"required\":[\"dismiss_stale_reviews_on_push\",\"require_code_owner_review\",\"require_last_push_approval\",\"required_approving_review_count\",\"required_review_thread_resolution\"]}}},{\"title\":\"required_status_checks\",\"description\":\"Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"required_status_checks\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"required_status_checks\":{\"type\":\"array\",\"description\":\"Status checks that are required.\",\"items\":{\"title\":\"StatusCheckConfiguration\",\"description\":\"Required status check\",\"type\":\"object\",\"properties\":{\"context\":{\"type\":\"string\",\"description\":\"The status check context name that must be present on the commit.\"},\"integration_id\":{\"type\":\"integer\",\"description\":\"The optional integration ID that this status check must originate from.\"}},\"required\":[\"context\"]}},\"strict_required_status_checks_policy\":{\"type\":\"boolean\",\"description\":\"Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled.\"}},\"required\":[\"required_status_checks\",\"strict_required_status_checks_policy\"]}}},{\"title\":\"non_fast_forward\",\"description\":\"Prevent users with push access from force pushing to branches.\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"non_fast_forward\"]}}},{\"title\":\"commit_message_pattern\",\"description\":\"Parameters to be used for the commit_message_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"commit_message_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}},{\"title\":\"commit_author_email_pattern\",\"description\":\"Parameters to be used for the commit_author_email_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"commit_author_email_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}},{\"title\":\"committer_email_pattern\",\"description\":\"Parameters to be used for the committer_email_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"committer_email_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}},{\"title\":\"branch_name_pattern\",\"description\":\"Parameters to be used for the branch_name_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"branch_name_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}},{\"title\":\"tag_name_pattern\",\"description\":\"Parameters to be used for the tag_name_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"tag_name_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}}]}}" } ], "parameters": [ { "name": "owner" }, { "name": "repo" }, - { "name": "branch" } + { "name": "branch" }, + { "name": "per_page" }, + { "name": "page" } ] }, { @@ -15671,7 +15742,7 @@ "responses": [ { "code": 200, - "schema": "{\"title\":\"Repository ruleset\",\"type\":\"object\",\"description\":\"A set of rules to apply when specified conditions are met.\",\"required\":[\"id\",\"name\",\"source\",\"enforcement\"],\"properties\":{\"id\":{\"type\":\"integer\",\"description\":\"The ID of the ruleset\"},\"name\":{\"type\":\"string\",\"description\":\"The name of the ruleset\"},\"target\":{\"type\":\"string\",\"description\":\"The target of the ruleset\",\"enum\":[\"branch\",\"tag\"]},\"source_type\":{\"type\":\"string\",\"description\":\"The type of the source of the ruleset\",\"enum\":[\"Repository\",\"Organization\"]},\"source\":{\"type\":\"string\",\"description\":\"The name of the source\"},\"enforcement\":{\"type\":\"string\",\"description\":\"The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise).\",\"enum\":[\"disabled\",\"active\",\"evaluate\"]},\"bypass_mode\":{\"type\":\"string\",\"description\":\"The permission level required to bypass this ruleset. \\\"repository\\\" allows those with bypass permission at the repository level to bypass. \\\"organization\\\" allows those with bypass permission at the organization level to bypass. \\\"none\\\" prevents anyone from bypassing.\",\"enum\":[\"none\",\"repository\",\"organization\"]},\"bypass_actors\":{\"type\":\"array\",\"description\":\"The actors that can bypass the rules in this ruleset\",\"items\":{\"title\":\"Repository Ruleset Bypass Actor\",\"type\":\"object\",\"description\":\"An actor that can bypass rules in a ruleset\",\"properties\":{\"actor_id\":{\"type\":\"integer\",\"description\":\"The ID of the actor that can bypass a ruleset\"},\"actor_type\":{\"type\":\"string\",\"enum\":[\"Team\",\"Integration\"],\"description\":\"The type of actor that can bypass a ruleset\"}}}},\"node_id\":{\"type\":\"string\"},\"_links\":{\"type\":\"object\",\"properties\":{\"self\":{\"type\":\"object\",\"properties\":{\"href\":{\"type\":\"string\",\"description\":\"The URL of the ruleset\"}}}}},\"conditions\":{\"anyOf\":[{\"title\":\"Repository ruleset conditions for ref names\",\"type\":\"object\",\"description\":\"Parameters for a repository ruleset ref name condition\",\"properties\":{\"ref_name\":{\"type\":\"object\",\"properties\":{\"include\":{\"type\":\"array\",\"description\":\"Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.\",\"items\":{\"type\":\"string\"}},\"exclude\":{\"type\":\"array\",\"description\":\"Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.\",\"items\":{\"type\":\"string\"}}}}}},{\"title\":\"Organization ruleset conditions\",\"type\":\"object\",\"description\":\"Conditions for a organization ruleset\",\"allOf\":[{\"title\":\"Repository ruleset conditions for ref names\",\"type\":\"object\",\"description\":\"Parameters for a repository ruleset ref name condition\",\"properties\":{\"ref_name\":{\"type\":\"object\",\"properties\":{\"include\":{\"type\":\"array\",\"description\":\"Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.\",\"items\":{\"type\":\"string\"}},\"exclude\":{\"type\":\"array\",\"description\":\"Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.\",\"items\":{\"type\":\"string\"}}}}}},{\"title\":\"Repository ruleset conditions for repository names\",\"type\":\"object\",\"description\":\"Parameters for a repository name condition\",\"properties\":{\"repository_name\":{\"type\":\"object\",\"properties\":{\"include\":{\"type\":\"array\",\"description\":\"Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.\",\"items\":{\"type\":\"string\"}},\"exclude\":{\"type\":\"array\",\"description\":\"Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.\",\"items\":{\"type\":\"string\"}},\"protected\":{\"type\":\"boolean\",\"description\":\"Whether renaming of target repositories is prevented.\"}}}}}]}]},\"rules\":{\"type\":\"array\",\"items\":{\"title\":\"Repository Rule\",\"type\":\"object\",\"description\":\"A repository rule.\",\"oneOf\":[{\"title\":\"creation\",\"description\":\"Parameters to be used for the creation rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"creation\"]}}},{\"title\":\"update\",\"description\":\"Parameters to be used for the update rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"update\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"update_allows_fetch_and_merge\":{\"type\":\"boolean\",\"description\":\"Branch can pull changes from its upstream repository\"}},\"required\":[\"update_allows_fetch_and_merge\"]}}},{\"title\":\"deletion\",\"description\":\"Parameters to be used for the deletion rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"deletion\"]}}},{\"title\":\"required_linear_history\",\"description\":\"Parameters to be used for the required_linear_history rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"required_linear_history\"]}}},{\"title\":\"required_deployments\",\"description\":\"Parameters to be used for the required_deployments rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"required_deployments\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"required_deployment_environments\":{\"type\":\"array\",\"description\":\"The environments that must be successfully deployed to before branches can be merged.\",\"items\":{\"type\":\"string\"}}},\"required\":[\"required_deployment_environments\"]}}},{\"title\":\"required_signatures\",\"description\":\"Parameters to be used for the required_signatures rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"required_signatures\"]}}},{\"title\":\"pull_request\",\"description\":\"Parameters to be used for the pull_request rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"pull_request\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"dismiss_stale_reviews_on_push\":{\"type\":\"boolean\",\"description\":\"New, reviewable commits pushed will dismiss previous pull request review approvals.\"},\"require_code_owner_review\":{\"type\":\"boolean\",\"description\":\"Require an approving review in pull requests that modify files that have a designated code owner.\"},\"require_last_push_approval\":{\"type\":\"boolean\",\"description\":\"Whether the most recent reviewable push must be approved by someone other than the person who pushed it.\"},\"required_approving_review_count\":{\"type\":\"integer\",\"description\":\"The number of approving reviews that are required before a pull request can be merged.\",\"minimum\":0,\"maximum\":10},\"required_review_thread_resolution\":{\"type\":\"boolean\",\"description\":\"All conversations on code must be resolved before a pull request can be merged.\"}},\"required\":[\"dismiss_stale_reviews_on_push\",\"require_code_owner_review\",\"require_last_push_approval\",\"required_approving_review_count\",\"required_review_thread_resolution\"]}}},{\"title\":\"required_status_checks\",\"description\":\"Parameters to be used for the required_status_checks rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"required_status_checks\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"required_status_checks\":{\"type\":\"array\",\"description\":\"Status checks that are required.\",\"items\":{\"title\":\"StatusCheckConfiguration\",\"description\":\"Required status check\",\"type\":\"object\",\"properties\":{\"context\":{\"type\":\"string\",\"description\":\"The status check context name that must be present on the commit.\"},\"integration_id\":{\"type\":\"integer\",\"description\":\"The optional integration ID that this status check must originate from.\"}},\"required\":[\"context\"]}},\"strict_required_status_checks_policy\":{\"type\":\"boolean\",\"description\":\"Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled.\"}},\"required\":[\"required_status_checks\",\"strict_required_status_checks_policy\"]}}},{\"title\":\"non_fast_forward\",\"description\":\"Parameters to be used for the non_fast_forward rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"non_fast_forward\"]}}},{\"title\":\"commit_message_pattern\",\"description\":\"Parameters to be used for the commit_message_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"commit_message_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}},{\"title\":\"commit_author_email_pattern\",\"description\":\"Parameters to be used for the commit_author_email_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"commit_author_email_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}},{\"title\":\"committer_email_pattern\",\"description\":\"Parameters to be used for the committer_email_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"committer_email_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}},{\"title\":\"branch_name_pattern\",\"description\":\"Parameters to be used for the branch_name_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"branch_name_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}},{\"title\":\"tag_name_pattern\",\"description\":\"Parameters to be used for the tag_name_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"tag_name_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}}]}}}}" + "schema": "{\"title\":\"Repository ruleset\",\"type\":\"object\",\"description\":\"A set of rules to apply when specified conditions are met.\",\"required\":[\"id\",\"name\",\"source\",\"enforcement\"],\"properties\":{\"id\":{\"type\":\"integer\",\"description\":\"The ID of the ruleset\"},\"name\":{\"type\":\"string\",\"description\":\"The name of the ruleset\"},\"target\":{\"type\":\"string\",\"description\":\"The target of the ruleset\",\"enum\":[\"branch\",\"tag\"]},\"source_type\":{\"type\":\"string\",\"description\":\"The type of the source of the ruleset\",\"enum\":[\"Repository\",\"Organization\"]},\"source\":{\"type\":\"string\",\"description\":\"The name of the source\"},\"enforcement\":{\"type\":\"string\",\"description\":\"The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise).\",\"enum\":[\"disabled\",\"active\",\"evaluate\"]},\"bypass_mode\":{\"type\":\"string\",\"description\":\"The permission level required to bypass this ruleset. \\\"repository\\\" allows those with bypass permission at the repository level to bypass. \\\"organization\\\" allows those with bypass permission at the organization level to bypass. \\\"none\\\" prevents anyone from bypassing.\",\"enum\":[\"none\",\"repository\",\"organization\"]},\"bypass_actors\":{\"type\":\"array\",\"description\":\"The actors that can bypass the rules in this ruleset\",\"items\":{\"title\":\"Repository Ruleset Bypass Actor\",\"type\":\"object\",\"description\":\"An actor that can bypass rules in a ruleset\",\"properties\":{\"actor_id\":{\"type\":\"integer\",\"description\":\"The ID of the actor that can bypass a ruleset\"},\"actor_type\":{\"type\":\"string\",\"enum\":[\"Team\",\"Integration\"],\"description\":\"The type of actor that can bypass a ruleset\"}}}},\"node_id\":{\"type\":\"string\"},\"_links\":{\"type\":\"object\",\"properties\":{\"self\":{\"type\":\"object\",\"properties\":{\"href\":{\"type\":\"string\",\"description\":\"The URL of the ruleset\"}}},\"html\":{\"type\":\"object\",\"properties\":{\"href\":{\"type\":\"string\",\"description\":\"The html URL of the ruleset\"}}}}},\"conditions\":{\"anyOf\":[{\"title\":\"Repository ruleset conditions for ref names\",\"type\":\"object\",\"description\":\"Parameters for a repository ruleset ref name condition\",\"properties\":{\"ref_name\":{\"type\":\"object\",\"properties\":{\"include\":{\"type\":\"array\",\"description\":\"Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.\",\"items\":{\"type\":\"string\"}},\"exclude\":{\"type\":\"array\",\"description\":\"Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.\",\"items\":{\"type\":\"string\"}}}}}},{\"title\":\"Organization ruleset conditions\",\"type\":\"object\",\"description\":\"Conditions for a organization ruleset\",\"allOf\":[{\"title\":\"Repository ruleset conditions for ref names\",\"type\":\"object\",\"description\":\"Parameters for a repository ruleset ref name condition\",\"properties\":{\"ref_name\":{\"type\":\"object\",\"properties\":{\"include\":{\"type\":\"array\",\"description\":\"Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.\",\"items\":{\"type\":\"string\"}},\"exclude\":{\"type\":\"array\",\"description\":\"Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.\",\"items\":{\"type\":\"string\"}}}}}},{\"title\":\"Repository ruleset conditions for repository names\",\"type\":\"object\",\"description\":\"Parameters for a repository name condition\",\"properties\":{\"repository_name\":{\"type\":\"object\",\"properties\":{\"include\":{\"type\":\"array\",\"description\":\"Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.\",\"items\":{\"type\":\"string\"}},\"exclude\":{\"type\":\"array\",\"description\":\"Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.\",\"items\":{\"type\":\"string\"}},\"protected\":{\"type\":\"boolean\",\"description\":\"Whether renaming of target repositories is prevented.\"}}}}}]}]},\"rules\":{\"type\":\"array\",\"items\":{\"title\":\"Repository Rule\",\"type\":\"object\",\"description\":\"A repository rule.\",\"oneOf\":[{\"title\":\"creation\",\"description\":\"Only allow users with bypass permission to create matching refs.\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"creation\"]}}},{\"title\":\"update\",\"description\":\"Only allow users with bypass permission to update matching refs.\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"update\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"update_allows_fetch_and_merge\":{\"type\":\"boolean\",\"description\":\"Branch can pull changes from its upstream repository\"}},\"required\":[\"update_allows_fetch_and_merge\"]}}},{\"title\":\"deletion\",\"description\":\"Only allow users with bypass permissions to delete matching refs.\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"deletion\"]}}},{\"title\":\"required_linear_history\",\"description\":\"Prevent merge commits from being pushed to matching branches.\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"required_linear_history\"]}}},{\"title\":\"required_deployments\",\"description\":\"Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule.\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"required_deployments\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"required_deployment_environments\":{\"type\":\"array\",\"description\":\"The environments that must be successfully deployed to before branches can be merged.\",\"items\":{\"type\":\"string\"}}},\"required\":[\"required_deployment_environments\"]}}},{\"title\":\"required_signatures\",\"description\":\"Commits pushed to matching branches must have verified signatures.\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"required_signatures\"]}}},{\"title\":\"pull_request\",\"description\":\"Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"pull_request\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"dismiss_stale_reviews_on_push\":{\"type\":\"boolean\",\"description\":\"New, reviewable commits pushed will dismiss previous pull request review approvals.\"},\"require_code_owner_review\":{\"type\":\"boolean\",\"description\":\"Require an approving review in pull requests that modify files that have a designated code owner.\"},\"require_last_push_approval\":{\"type\":\"boolean\",\"description\":\"Whether the most recent reviewable push must be approved by someone other than the person who pushed it.\"},\"required_approving_review_count\":{\"type\":\"integer\",\"description\":\"The number of approving reviews that are required before a pull request can be merged.\",\"minimum\":0,\"maximum\":10},\"required_review_thread_resolution\":{\"type\":\"boolean\",\"description\":\"All conversations on code must be resolved before a pull request can be merged.\"}},\"required\":[\"dismiss_stale_reviews_on_push\",\"require_code_owner_review\",\"require_last_push_approval\",\"required_approving_review_count\",\"required_review_thread_resolution\"]}}},{\"title\":\"required_status_checks\",\"description\":\"Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"required_status_checks\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"required_status_checks\":{\"type\":\"array\",\"description\":\"Status checks that are required.\",\"items\":{\"title\":\"StatusCheckConfiguration\",\"description\":\"Required status check\",\"type\":\"object\",\"properties\":{\"context\":{\"type\":\"string\",\"description\":\"The status check context name that must be present on the commit.\"},\"integration_id\":{\"type\":\"integer\",\"description\":\"The optional integration ID that this status check must originate from.\"}},\"required\":[\"context\"]}},\"strict_required_status_checks_policy\":{\"type\":\"boolean\",\"description\":\"Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled.\"}},\"required\":[\"required_status_checks\",\"strict_required_status_checks_policy\"]}}},{\"title\":\"non_fast_forward\",\"description\":\"Prevent users with push access from force pushing to branches.\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"non_fast_forward\"]}}},{\"title\":\"commit_message_pattern\",\"description\":\"Parameters to be used for the commit_message_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"commit_message_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}},{\"title\":\"commit_author_email_pattern\",\"description\":\"Parameters to be used for the commit_author_email_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"commit_author_email_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}},{\"title\":\"committer_email_pattern\",\"description\":\"Parameters to be used for the committer_email_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"committer_email_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}},{\"title\":\"branch_name_pattern\",\"description\":\"Parameters to be used for the branch_name_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"branch_name_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}},{\"title\":\"tag_name_pattern\",\"description\":\"Parameters to be used for the tag_name_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"tag_name_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}}]}},\"created_at\":{\"type\":\"string\",\"format\":\"date-time\"},\"updated_at\":{\"type\":\"string\",\"format\":\"date-time\"}}}" }, { "code": 404, @@ -15693,7 +15764,7 @@ "responses": [ { "code": 200, - "schema": "{\"type\":\"array\",\"items\":{\"title\":\"Repository ruleset\",\"type\":\"object\",\"description\":\"A set of rules to apply when specified conditions are met.\",\"required\":[\"id\",\"name\",\"source\",\"enforcement\"],\"properties\":{\"id\":{\"type\":\"integer\",\"description\":\"The ID of the ruleset\"},\"name\":{\"type\":\"string\",\"description\":\"The name of the ruleset\"},\"target\":{\"type\":\"string\",\"description\":\"The target of the ruleset\",\"enum\":[\"branch\",\"tag\"]},\"source_type\":{\"type\":\"string\",\"description\":\"The type of the source of the ruleset\",\"enum\":[\"Repository\",\"Organization\"]},\"source\":{\"type\":\"string\",\"description\":\"The name of the source\"},\"enforcement\":{\"type\":\"string\",\"description\":\"The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise).\",\"enum\":[\"disabled\",\"active\",\"evaluate\"]},\"bypass_mode\":{\"type\":\"string\",\"description\":\"The permission level required to bypass this ruleset. \\\"repository\\\" allows those with bypass permission at the repository level to bypass. \\\"organization\\\" allows those with bypass permission at the organization level to bypass. \\\"none\\\" prevents anyone from bypassing.\",\"enum\":[\"none\",\"repository\",\"organization\"]},\"bypass_actors\":{\"type\":\"array\",\"description\":\"The actors that can bypass the rules in this ruleset\",\"items\":{\"title\":\"Repository Ruleset Bypass Actor\",\"type\":\"object\",\"description\":\"An actor that can bypass rules in a ruleset\",\"properties\":{\"actor_id\":{\"type\":\"integer\",\"description\":\"The ID of the actor that can bypass a ruleset\"},\"actor_type\":{\"type\":\"string\",\"enum\":[\"Team\",\"Integration\"],\"description\":\"The type of actor that can bypass a ruleset\"}}}},\"node_id\":{\"type\":\"string\"},\"_links\":{\"type\":\"object\",\"properties\":{\"self\":{\"type\":\"object\",\"properties\":{\"href\":{\"type\":\"string\",\"description\":\"The URL of the ruleset\"}}}}},\"conditions\":{\"anyOf\":[{\"title\":\"Repository ruleset conditions for ref names\",\"type\":\"object\",\"description\":\"Parameters for a repository ruleset ref name condition\",\"properties\":{\"ref_name\":{\"type\":\"object\",\"properties\":{\"include\":{\"type\":\"array\",\"description\":\"Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.\",\"items\":{\"type\":\"string\"}},\"exclude\":{\"type\":\"array\",\"description\":\"Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.\",\"items\":{\"type\":\"string\"}}}}}},{\"title\":\"Organization ruleset conditions\",\"type\":\"object\",\"description\":\"Conditions for a organization ruleset\",\"allOf\":[{\"title\":\"Repository ruleset conditions for ref names\",\"type\":\"object\",\"description\":\"Parameters for a repository ruleset ref name condition\",\"properties\":{\"ref_name\":{\"type\":\"object\",\"properties\":{\"include\":{\"type\":\"array\",\"description\":\"Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.\",\"items\":{\"type\":\"string\"}},\"exclude\":{\"type\":\"array\",\"description\":\"Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.\",\"items\":{\"type\":\"string\"}}}}}},{\"title\":\"Repository ruleset conditions for repository names\",\"type\":\"object\",\"description\":\"Parameters for a repository name condition\",\"properties\":{\"repository_name\":{\"type\":\"object\",\"properties\":{\"include\":{\"type\":\"array\",\"description\":\"Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.\",\"items\":{\"type\":\"string\"}},\"exclude\":{\"type\":\"array\",\"description\":\"Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.\",\"items\":{\"type\":\"string\"}},\"protected\":{\"type\":\"boolean\",\"description\":\"Whether renaming of target repositories is prevented.\"}}}}}]}]},\"rules\":{\"type\":\"array\",\"items\":{\"title\":\"Repository Rule\",\"type\":\"object\",\"description\":\"A repository rule.\",\"oneOf\":[{\"title\":\"creation\",\"description\":\"Parameters to be used for the creation rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"creation\"]}}},{\"title\":\"update\",\"description\":\"Parameters to be used for the update rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"update\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"update_allows_fetch_and_merge\":{\"type\":\"boolean\",\"description\":\"Branch can pull changes from its upstream repository\"}},\"required\":[\"update_allows_fetch_and_merge\"]}}},{\"title\":\"deletion\",\"description\":\"Parameters to be used for the deletion rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"deletion\"]}}},{\"title\":\"required_linear_history\",\"description\":\"Parameters to be used for the required_linear_history rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"required_linear_history\"]}}},{\"title\":\"required_deployments\",\"description\":\"Parameters to be used for the required_deployments rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"required_deployments\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"required_deployment_environments\":{\"type\":\"array\",\"description\":\"The environments that must be successfully deployed to before branches can be merged.\",\"items\":{\"type\":\"string\"}}},\"required\":[\"required_deployment_environments\"]}}},{\"title\":\"required_signatures\",\"description\":\"Parameters to be used for the required_signatures rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"required_signatures\"]}}},{\"title\":\"pull_request\",\"description\":\"Parameters to be used for the pull_request rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"pull_request\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"dismiss_stale_reviews_on_push\":{\"type\":\"boolean\",\"description\":\"New, reviewable commits pushed will dismiss previous pull request review approvals.\"},\"require_code_owner_review\":{\"type\":\"boolean\",\"description\":\"Require an approving review in pull requests that modify files that have a designated code owner.\"},\"require_last_push_approval\":{\"type\":\"boolean\",\"description\":\"Whether the most recent reviewable push must be approved by someone other than the person who pushed it.\"},\"required_approving_review_count\":{\"type\":\"integer\",\"description\":\"The number of approving reviews that are required before a pull request can be merged.\",\"minimum\":0,\"maximum\":10},\"required_review_thread_resolution\":{\"type\":\"boolean\",\"description\":\"All conversations on code must be resolved before a pull request can be merged.\"}},\"required\":[\"dismiss_stale_reviews_on_push\",\"require_code_owner_review\",\"require_last_push_approval\",\"required_approving_review_count\",\"required_review_thread_resolution\"]}}},{\"title\":\"required_status_checks\",\"description\":\"Parameters to be used for the required_status_checks rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"required_status_checks\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"required_status_checks\":{\"type\":\"array\",\"description\":\"Status checks that are required.\",\"items\":{\"title\":\"StatusCheckConfiguration\",\"description\":\"Required status check\",\"type\":\"object\",\"properties\":{\"context\":{\"type\":\"string\",\"description\":\"The status check context name that must be present on the commit.\"},\"integration_id\":{\"type\":\"integer\",\"description\":\"The optional integration ID that this status check must originate from.\"}},\"required\":[\"context\"]}},\"strict_required_status_checks_policy\":{\"type\":\"boolean\",\"description\":\"Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled.\"}},\"required\":[\"required_status_checks\",\"strict_required_status_checks_policy\"]}}},{\"title\":\"non_fast_forward\",\"description\":\"Parameters to be used for the non_fast_forward rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"non_fast_forward\"]}}},{\"title\":\"commit_message_pattern\",\"description\":\"Parameters to be used for the commit_message_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"commit_message_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}},{\"title\":\"commit_author_email_pattern\",\"description\":\"Parameters to be used for the commit_author_email_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"commit_author_email_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}},{\"title\":\"committer_email_pattern\",\"description\":\"Parameters to be used for the committer_email_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"committer_email_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}},{\"title\":\"branch_name_pattern\",\"description\":\"Parameters to be used for the branch_name_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"branch_name_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}},{\"title\":\"tag_name_pattern\",\"description\":\"Parameters to be used for the tag_name_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"tag_name_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}}]}}}}}" + "schema": "{\"type\":\"array\",\"items\":{\"title\":\"Repository ruleset\",\"type\":\"object\",\"description\":\"A set of rules to apply when specified conditions are met.\",\"required\":[\"id\",\"name\",\"source\",\"enforcement\"],\"properties\":{\"id\":{\"type\":\"integer\",\"description\":\"The ID of the ruleset\"},\"name\":{\"type\":\"string\",\"description\":\"The name of the ruleset\"},\"target\":{\"type\":\"string\",\"description\":\"The target of the ruleset\",\"enum\":[\"branch\",\"tag\"]},\"source_type\":{\"type\":\"string\",\"description\":\"The type of the source of the ruleset\",\"enum\":[\"Repository\",\"Organization\"]},\"source\":{\"type\":\"string\",\"description\":\"The name of the source\"},\"enforcement\":{\"type\":\"string\",\"description\":\"The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise).\",\"enum\":[\"disabled\",\"active\",\"evaluate\"]},\"bypass_mode\":{\"type\":\"string\",\"description\":\"The permission level required to bypass this ruleset. \\\"repository\\\" allows those with bypass permission at the repository level to bypass. \\\"organization\\\" allows those with bypass permission at the organization level to bypass. \\\"none\\\" prevents anyone from bypassing.\",\"enum\":[\"none\",\"repository\",\"organization\"]},\"bypass_actors\":{\"type\":\"array\",\"description\":\"The actors that can bypass the rules in this ruleset\",\"items\":{\"title\":\"Repository Ruleset Bypass Actor\",\"type\":\"object\",\"description\":\"An actor that can bypass rules in a ruleset\",\"properties\":{\"actor_id\":{\"type\":\"integer\",\"description\":\"The ID of the actor that can bypass a ruleset\"},\"actor_type\":{\"type\":\"string\",\"enum\":[\"Team\",\"Integration\"],\"description\":\"The type of actor that can bypass a ruleset\"}}}},\"node_id\":{\"type\":\"string\"},\"_links\":{\"type\":\"object\",\"properties\":{\"self\":{\"type\":\"object\",\"properties\":{\"href\":{\"type\":\"string\",\"description\":\"The URL of the ruleset\"}}},\"html\":{\"type\":\"object\",\"properties\":{\"href\":{\"type\":\"string\",\"description\":\"The html URL of the ruleset\"}}}}},\"conditions\":{\"anyOf\":[{\"title\":\"Repository ruleset conditions for ref names\",\"type\":\"object\",\"description\":\"Parameters for a repository ruleset ref name condition\",\"properties\":{\"ref_name\":{\"type\":\"object\",\"properties\":{\"include\":{\"type\":\"array\",\"description\":\"Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.\",\"items\":{\"type\":\"string\"}},\"exclude\":{\"type\":\"array\",\"description\":\"Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.\",\"items\":{\"type\":\"string\"}}}}}},{\"title\":\"Organization ruleset conditions\",\"type\":\"object\",\"description\":\"Conditions for a organization ruleset\",\"allOf\":[{\"title\":\"Repository ruleset conditions for ref names\",\"type\":\"object\",\"description\":\"Parameters for a repository ruleset ref name condition\",\"properties\":{\"ref_name\":{\"type\":\"object\",\"properties\":{\"include\":{\"type\":\"array\",\"description\":\"Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.\",\"items\":{\"type\":\"string\"}},\"exclude\":{\"type\":\"array\",\"description\":\"Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.\",\"items\":{\"type\":\"string\"}}}}}},{\"title\":\"Repository ruleset conditions for repository names\",\"type\":\"object\",\"description\":\"Parameters for a repository name condition\",\"properties\":{\"repository_name\":{\"type\":\"object\",\"properties\":{\"include\":{\"type\":\"array\",\"description\":\"Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.\",\"items\":{\"type\":\"string\"}},\"exclude\":{\"type\":\"array\",\"description\":\"Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.\",\"items\":{\"type\":\"string\"}},\"protected\":{\"type\":\"boolean\",\"description\":\"Whether renaming of target repositories is prevented.\"}}}}}]}]},\"rules\":{\"type\":\"array\",\"items\":{\"title\":\"Repository Rule\",\"type\":\"object\",\"description\":\"A repository rule.\",\"oneOf\":[{\"title\":\"creation\",\"description\":\"Only allow users with bypass permission to create matching refs.\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"creation\"]}}},{\"title\":\"update\",\"description\":\"Only allow users with bypass permission to update matching refs.\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"update\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"update_allows_fetch_and_merge\":{\"type\":\"boolean\",\"description\":\"Branch can pull changes from its upstream repository\"}},\"required\":[\"update_allows_fetch_and_merge\"]}}},{\"title\":\"deletion\",\"description\":\"Only allow users with bypass permissions to delete matching refs.\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"deletion\"]}}},{\"title\":\"required_linear_history\",\"description\":\"Prevent merge commits from being pushed to matching branches.\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"required_linear_history\"]}}},{\"title\":\"required_deployments\",\"description\":\"Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule.\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"required_deployments\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"required_deployment_environments\":{\"type\":\"array\",\"description\":\"The environments that must be successfully deployed to before branches can be merged.\",\"items\":{\"type\":\"string\"}}},\"required\":[\"required_deployment_environments\"]}}},{\"title\":\"required_signatures\",\"description\":\"Commits pushed to matching branches must have verified signatures.\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"required_signatures\"]}}},{\"title\":\"pull_request\",\"description\":\"Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"pull_request\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"dismiss_stale_reviews_on_push\":{\"type\":\"boolean\",\"description\":\"New, reviewable commits pushed will dismiss previous pull request review approvals.\"},\"require_code_owner_review\":{\"type\":\"boolean\",\"description\":\"Require an approving review in pull requests that modify files that have a designated code owner.\"},\"require_last_push_approval\":{\"type\":\"boolean\",\"description\":\"Whether the most recent reviewable push must be approved by someone other than the person who pushed it.\"},\"required_approving_review_count\":{\"type\":\"integer\",\"description\":\"The number of approving reviews that are required before a pull request can be merged.\",\"minimum\":0,\"maximum\":10},\"required_review_thread_resolution\":{\"type\":\"boolean\",\"description\":\"All conversations on code must be resolved before a pull request can be merged.\"}},\"required\":[\"dismiss_stale_reviews_on_push\",\"require_code_owner_review\",\"require_last_push_approval\",\"required_approving_review_count\",\"required_review_thread_resolution\"]}}},{\"title\":\"required_status_checks\",\"description\":\"Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"required_status_checks\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"required_status_checks\":{\"type\":\"array\",\"description\":\"Status checks that are required.\",\"items\":{\"title\":\"StatusCheckConfiguration\",\"description\":\"Required status check\",\"type\":\"object\",\"properties\":{\"context\":{\"type\":\"string\",\"description\":\"The status check context name that must be present on the commit.\"},\"integration_id\":{\"type\":\"integer\",\"description\":\"The optional integration ID that this status check must originate from.\"}},\"required\":[\"context\"]}},\"strict_required_status_checks_policy\":{\"type\":\"boolean\",\"description\":\"Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled.\"}},\"required\":[\"required_status_checks\",\"strict_required_status_checks_policy\"]}}},{\"title\":\"non_fast_forward\",\"description\":\"Prevent users with push access from force pushing to branches.\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"non_fast_forward\"]}}},{\"title\":\"commit_message_pattern\",\"description\":\"Parameters to be used for the commit_message_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"commit_message_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}},{\"title\":\"commit_author_email_pattern\",\"description\":\"Parameters to be used for the commit_author_email_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"commit_author_email_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}},{\"title\":\"committer_email_pattern\",\"description\":\"Parameters to be used for the committer_email_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"committer_email_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}},{\"title\":\"branch_name_pattern\",\"description\":\"Parameters to be used for the branch_name_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"branch_name_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}},{\"title\":\"tag_name_pattern\",\"description\":\"Parameters to be used for the tag_name_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"tag_name_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}}]}},\"created_at\":{\"type\":\"string\",\"format\":\"date-time\"},\"updated_at\":{\"type\":\"string\",\"format\":\"date-time\"}}}}" }, { "code": 404, @@ -15704,7 +15775,11 @@ "schema": "{\"title\":\"Basic Error\",\"description\":\"Basic Error\",\"type\":\"object\",\"properties\":{\"message\":{\"type\":\"string\"},\"documentation_url\":{\"type\":\"string\"},\"url\":{\"type\":\"string\"},\"status\":{\"type\":\"string\"}}}" } ], - "parameters": [{ "name": "org" }] + "parameters": [ + { "name": "org" }, + { "name": "per_page" }, + { "name": "page" } + ] }, { "url": "/repos/{owner}/{repo}/pages", @@ -15938,7 +16013,7 @@ "responses": [ { "code": 200, - "schema": "{\"title\":\"Repository ruleset\",\"type\":\"object\",\"description\":\"A set of rules to apply when specified conditions are met.\",\"required\":[\"id\",\"name\",\"source\",\"enforcement\"],\"properties\":{\"id\":{\"type\":\"integer\",\"description\":\"The ID of the ruleset\"},\"name\":{\"type\":\"string\",\"description\":\"The name of the ruleset\"},\"target\":{\"type\":\"string\",\"description\":\"The target of the ruleset\",\"enum\":[\"branch\",\"tag\"]},\"source_type\":{\"type\":\"string\",\"description\":\"The type of the source of the ruleset\",\"enum\":[\"Repository\",\"Organization\"]},\"source\":{\"type\":\"string\",\"description\":\"The name of the source\"},\"enforcement\":{\"type\":\"string\",\"description\":\"The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise).\",\"enum\":[\"disabled\",\"active\",\"evaluate\"]},\"bypass_mode\":{\"type\":\"string\",\"description\":\"The permission level required to bypass this ruleset. \\\"repository\\\" allows those with bypass permission at the repository level to bypass. \\\"organization\\\" allows those with bypass permission at the organization level to bypass. \\\"none\\\" prevents anyone from bypassing.\",\"enum\":[\"none\",\"repository\",\"organization\"]},\"bypass_actors\":{\"type\":\"array\",\"description\":\"The actors that can bypass the rules in this ruleset\",\"items\":{\"title\":\"Repository Ruleset Bypass Actor\",\"type\":\"object\",\"description\":\"An actor that can bypass rules in a ruleset\",\"properties\":{\"actor_id\":{\"type\":\"integer\",\"description\":\"The ID of the actor that can bypass a ruleset\"},\"actor_type\":{\"type\":\"string\",\"enum\":[\"Team\",\"Integration\"],\"description\":\"The type of actor that can bypass a ruleset\"}}}},\"node_id\":{\"type\":\"string\"},\"_links\":{\"type\":\"object\",\"properties\":{\"self\":{\"type\":\"object\",\"properties\":{\"href\":{\"type\":\"string\",\"description\":\"The URL of the ruleset\"}}}}},\"conditions\":{\"anyOf\":[{\"title\":\"Repository ruleset conditions for ref names\",\"type\":\"object\",\"description\":\"Parameters for a repository ruleset ref name condition\",\"properties\":{\"ref_name\":{\"type\":\"object\",\"properties\":{\"include\":{\"type\":\"array\",\"description\":\"Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.\",\"items\":{\"type\":\"string\"}},\"exclude\":{\"type\":\"array\",\"description\":\"Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.\",\"items\":{\"type\":\"string\"}}}}}},{\"title\":\"Organization ruleset conditions\",\"type\":\"object\",\"description\":\"Conditions for a organization ruleset\",\"allOf\":[{\"title\":\"Repository ruleset conditions for ref names\",\"type\":\"object\",\"description\":\"Parameters for a repository ruleset ref name condition\",\"properties\":{\"ref_name\":{\"type\":\"object\",\"properties\":{\"include\":{\"type\":\"array\",\"description\":\"Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.\",\"items\":{\"type\":\"string\"}},\"exclude\":{\"type\":\"array\",\"description\":\"Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.\",\"items\":{\"type\":\"string\"}}}}}},{\"title\":\"Repository ruleset conditions for repository names\",\"type\":\"object\",\"description\":\"Parameters for a repository name condition\",\"properties\":{\"repository_name\":{\"type\":\"object\",\"properties\":{\"include\":{\"type\":\"array\",\"description\":\"Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.\",\"items\":{\"type\":\"string\"}},\"exclude\":{\"type\":\"array\",\"description\":\"Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.\",\"items\":{\"type\":\"string\"}},\"protected\":{\"type\":\"boolean\",\"description\":\"Whether renaming of target repositories is prevented.\"}}}}}]}]},\"rules\":{\"type\":\"array\",\"items\":{\"title\":\"Repository Rule\",\"type\":\"object\",\"description\":\"A repository rule.\",\"oneOf\":[{\"title\":\"creation\",\"description\":\"Parameters to be used for the creation rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"creation\"]}}},{\"title\":\"update\",\"description\":\"Parameters to be used for the update rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"update\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"update_allows_fetch_and_merge\":{\"type\":\"boolean\",\"description\":\"Branch can pull changes from its upstream repository\"}},\"required\":[\"update_allows_fetch_and_merge\"]}}},{\"title\":\"deletion\",\"description\":\"Parameters to be used for the deletion rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"deletion\"]}}},{\"title\":\"required_linear_history\",\"description\":\"Parameters to be used for the required_linear_history rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"required_linear_history\"]}}},{\"title\":\"required_deployments\",\"description\":\"Parameters to be used for the required_deployments rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"required_deployments\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"required_deployment_environments\":{\"type\":\"array\",\"description\":\"The environments that must be successfully deployed to before branches can be merged.\",\"items\":{\"type\":\"string\"}}},\"required\":[\"required_deployment_environments\"]}}},{\"title\":\"required_signatures\",\"description\":\"Parameters to be used for the required_signatures rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"required_signatures\"]}}},{\"title\":\"pull_request\",\"description\":\"Parameters to be used for the pull_request rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"pull_request\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"dismiss_stale_reviews_on_push\":{\"type\":\"boolean\",\"description\":\"New, reviewable commits pushed will dismiss previous pull request review approvals.\"},\"require_code_owner_review\":{\"type\":\"boolean\",\"description\":\"Require an approving review in pull requests that modify files that have a designated code owner.\"},\"require_last_push_approval\":{\"type\":\"boolean\",\"description\":\"Whether the most recent reviewable push must be approved by someone other than the person who pushed it.\"},\"required_approving_review_count\":{\"type\":\"integer\",\"description\":\"The number of approving reviews that are required before a pull request can be merged.\",\"minimum\":0,\"maximum\":10},\"required_review_thread_resolution\":{\"type\":\"boolean\",\"description\":\"All conversations on code must be resolved before a pull request can be merged.\"}},\"required\":[\"dismiss_stale_reviews_on_push\",\"require_code_owner_review\",\"require_last_push_approval\",\"required_approving_review_count\",\"required_review_thread_resolution\"]}}},{\"title\":\"required_status_checks\",\"description\":\"Parameters to be used for the required_status_checks rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"required_status_checks\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"required_status_checks\":{\"type\":\"array\",\"description\":\"Status checks that are required.\",\"items\":{\"title\":\"StatusCheckConfiguration\",\"description\":\"Required status check\",\"type\":\"object\",\"properties\":{\"context\":{\"type\":\"string\",\"description\":\"The status check context name that must be present on the commit.\"},\"integration_id\":{\"type\":\"integer\",\"description\":\"The optional integration ID that this status check must originate from.\"}},\"required\":[\"context\"]}},\"strict_required_status_checks_policy\":{\"type\":\"boolean\",\"description\":\"Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled.\"}},\"required\":[\"required_status_checks\",\"strict_required_status_checks_policy\"]}}},{\"title\":\"non_fast_forward\",\"description\":\"Parameters to be used for the non_fast_forward rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"non_fast_forward\"]}}},{\"title\":\"commit_message_pattern\",\"description\":\"Parameters to be used for the commit_message_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"commit_message_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}},{\"title\":\"commit_author_email_pattern\",\"description\":\"Parameters to be used for the commit_author_email_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"commit_author_email_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}},{\"title\":\"committer_email_pattern\",\"description\":\"Parameters to be used for the committer_email_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"committer_email_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}},{\"title\":\"branch_name_pattern\",\"description\":\"Parameters to be used for the branch_name_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"branch_name_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}},{\"title\":\"tag_name_pattern\",\"description\":\"Parameters to be used for the tag_name_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"tag_name_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}}]}}}}" + "schema": "{\"title\":\"Repository ruleset\",\"type\":\"object\",\"description\":\"A set of rules to apply when specified conditions are met.\",\"required\":[\"id\",\"name\",\"source\",\"enforcement\"],\"properties\":{\"id\":{\"type\":\"integer\",\"description\":\"The ID of the ruleset\"},\"name\":{\"type\":\"string\",\"description\":\"The name of the ruleset\"},\"target\":{\"type\":\"string\",\"description\":\"The target of the ruleset\",\"enum\":[\"branch\",\"tag\"]},\"source_type\":{\"type\":\"string\",\"description\":\"The type of the source of the ruleset\",\"enum\":[\"Repository\",\"Organization\"]},\"source\":{\"type\":\"string\",\"description\":\"The name of the source\"},\"enforcement\":{\"type\":\"string\",\"description\":\"The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise).\",\"enum\":[\"disabled\",\"active\",\"evaluate\"]},\"bypass_mode\":{\"type\":\"string\",\"description\":\"The permission level required to bypass this ruleset. \\\"repository\\\" allows those with bypass permission at the repository level to bypass. \\\"organization\\\" allows those with bypass permission at the organization level to bypass. \\\"none\\\" prevents anyone from bypassing.\",\"enum\":[\"none\",\"repository\",\"organization\"]},\"bypass_actors\":{\"type\":\"array\",\"description\":\"The actors that can bypass the rules in this ruleset\",\"items\":{\"title\":\"Repository Ruleset Bypass Actor\",\"type\":\"object\",\"description\":\"An actor that can bypass rules in a ruleset\",\"properties\":{\"actor_id\":{\"type\":\"integer\",\"description\":\"The ID of the actor that can bypass a ruleset\"},\"actor_type\":{\"type\":\"string\",\"enum\":[\"Team\",\"Integration\"],\"description\":\"The type of actor that can bypass a ruleset\"}}}},\"node_id\":{\"type\":\"string\"},\"_links\":{\"type\":\"object\",\"properties\":{\"self\":{\"type\":\"object\",\"properties\":{\"href\":{\"type\":\"string\",\"description\":\"The URL of the ruleset\"}}},\"html\":{\"type\":\"object\",\"properties\":{\"href\":{\"type\":\"string\",\"description\":\"The html URL of the ruleset\"}}}}},\"conditions\":{\"anyOf\":[{\"title\":\"Repository ruleset conditions for ref names\",\"type\":\"object\",\"description\":\"Parameters for a repository ruleset ref name condition\",\"properties\":{\"ref_name\":{\"type\":\"object\",\"properties\":{\"include\":{\"type\":\"array\",\"description\":\"Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.\",\"items\":{\"type\":\"string\"}},\"exclude\":{\"type\":\"array\",\"description\":\"Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.\",\"items\":{\"type\":\"string\"}}}}}},{\"title\":\"Organization ruleset conditions\",\"type\":\"object\",\"description\":\"Conditions for a organization ruleset\",\"allOf\":[{\"title\":\"Repository ruleset conditions for ref names\",\"type\":\"object\",\"description\":\"Parameters for a repository ruleset ref name condition\",\"properties\":{\"ref_name\":{\"type\":\"object\",\"properties\":{\"include\":{\"type\":\"array\",\"description\":\"Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.\",\"items\":{\"type\":\"string\"}},\"exclude\":{\"type\":\"array\",\"description\":\"Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.\",\"items\":{\"type\":\"string\"}}}}}},{\"title\":\"Repository ruleset conditions for repository names\",\"type\":\"object\",\"description\":\"Parameters for a repository name condition\",\"properties\":{\"repository_name\":{\"type\":\"object\",\"properties\":{\"include\":{\"type\":\"array\",\"description\":\"Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.\",\"items\":{\"type\":\"string\"}},\"exclude\":{\"type\":\"array\",\"description\":\"Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.\",\"items\":{\"type\":\"string\"}},\"protected\":{\"type\":\"boolean\",\"description\":\"Whether renaming of target repositories is prevented.\"}}}}}]}]},\"rules\":{\"type\":\"array\",\"items\":{\"title\":\"Repository Rule\",\"type\":\"object\",\"description\":\"A repository rule.\",\"oneOf\":[{\"title\":\"creation\",\"description\":\"Only allow users with bypass permission to create matching refs.\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"creation\"]}}},{\"title\":\"update\",\"description\":\"Only allow users with bypass permission to update matching refs.\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"update\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"update_allows_fetch_and_merge\":{\"type\":\"boolean\",\"description\":\"Branch can pull changes from its upstream repository\"}},\"required\":[\"update_allows_fetch_and_merge\"]}}},{\"title\":\"deletion\",\"description\":\"Only allow users with bypass permissions to delete matching refs.\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"deletion\"]}}},{\"title\":\"required_linear_history\",\"description\":\"Prevent merge commits from being pushed to matching branches.\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"required_linear_history\"]}}},{\"title\":\"required_deployments\",\"description\":\"Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule.\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"required_deployments\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"required_deployment_environments\":{\"type\":\"array\",\"description\":\"The environments that must be successfully deployed to before branches can be merged.\",\"items\":{\"type\":\"string\"}}},\"required\":[\"required_deployment_environments\"]}}},{\"title\":\"required_signatures\",\"description\":\"Commits pushed to matching branches must have verified signatures.\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"required_signatures\"]}}},{\"title\":\"pull_request\",\"description\":\"Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"pull_request\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"dismiss_stale_reviews_on_push\":{\"type\":\"boolean\",\"description\":\"New, reviewable commits pushed will dismiss previous pull request review approvals.\"},\"require_code_owner_review\":{\"type\":\"boolean\",\"description\":\"Require an approving review in pull requests that modify files that have a designated code owner.\"},\"require_last_push_approval\":{\"type\":\"boolean\",\"description\":\"Whether the most recent reviewable push must be approved by someone other than the person who pushed it.\"},\"required_approving_review_count\":{\"type\":\"integer\",\"description\":\"The number of approving reviews that are required before a pull request can be merged.\",\"minimum\":0,\"maximum\":10},\"required_review_thread_resolution\":{\"type\":\"boolean\",\"description\":\"All conversations on code must be resolved before a pull request can be merged.\"}},\"required\":[\"dismiss_stale_reviews_on_push\",\"require_code_owner_review\",\"require_last_push_approval\",\"required_approving_review_count\",\"required_review_thread_resolution\"]}}},{\"title\":\"required_status_checks\",\"description\":\"Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"required_status_checks\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"required_status_checks\":{\"type\":\"array\",\"description\":\"Status checks that are required.\",\"items\":{\"title\":\"StatusCheckConfiguration\",\"description\":\"Required status check\",\"type\":\"object\",\"properties\":{\"context\":{\"type\":\"string\",\"description\":\"The status check context name that must be present on the commit.\"},\"integration_id\":{\"type\":\"integer\",\"description\":\"The optional integration ID that this status check must originate from.\"}},\"required\":[\"context\"]}},\"strict_required_status_checks_policy\":{\"type\":\"boolean\",\"description\":\"Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled.\"}},\"required\":[\"required_status_checks\",\"strict_required_status_checks_policy\"]}}},{\"title\":\"non_fast_forward\",\"description\":\"Prevent users with push access from force pushing to branches.\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"non_fast_forward\"]}}},{\"title\":\"commit_message_pattern\",\"description\":\"Parameters to be used for the commit_message_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"commit_message_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}},{\"title\":\"commit_author_email_pattern\",\"description\":\"Parameters to be used for the commit_author_email_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"commit_author_email_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}},{\"title\":\"committer_email_pattern\",\"description\":\"Parameters to be used for the committer_email_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"committer_email_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}},{\"title\":\"branch_name_pattern\",\"description\":\"Parameters to be used for the branch_name_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"branch_name_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}},{\"title\":\"tag_name_pattern\",\"description\":\"Parameters to be used for the tag_name_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"tag_name_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}}]}},\"created_at\":{\"type\":\"string\",\"format\":\"date-time\"},\"updated_at\":{\"type\":\"string\",\"format\":\"date-time\"}}}" }, { "code": 404, @@ -15965,7 +16040,7 @@ "responses": [ { "code": 200, - "schema": "{\"type\":\"array\",\"items\":{\"title\":\"Repository ruleset\",\"type\":\"object\",\"description\":\"A set of rules to apply when specified conditions are met.\",\"required\":[\"id\",\"name\",\"source\",\"enforcement\"],\"properties\":{\"id\":{\"type\":\"integer\",\"description\":\"The ID of the ruleset\"},\"name\":{\"type\":\"string\",\"description\":\"The name of the ruleset\"},\"target\":{\"type\":\"string\",\"description\":\"The target of the ruleset\",\"enum\":[\"branch\",\"tag\"]},\"source_type\":{\"type\":\"string\",\"description\":\"The type of the source of the ruleset\",\"enum\":[\"Repository\",\"Organization\"]},\"source\":{\"type\":\"string\",\"description\":\"The name of the source\"},\"enforcement\":{\"type\":\"string\",\"description\":\"The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise).\",\"enum\":[\"disabled\",\"active\",\"evaluate\"]},\"bypass_mode\":{\"type\":\"string\",\"description\":\"The permission level required to bypass this ruleset. \\\"repository\\\" allows those with bypass permission at the repository level to bypass. \\\"organization\\\" allows those with bypass permission at the organization level to bypass. \\\"none\\\" prevents anyone from bypassing.\",\"enum\":[\"none\",\"repository\",\"organization\"]},\"bypass_actors\":{\"type\":\"array\",\"description\":\"The actors that can bypass the rules in this ruleset\",\"items\":{\"title\":\"Repository Ruleset Bypass Actor\",\"type\":\"object\",\"description\":\"An actor that can bypass rules in a ruleset\",\"properties\":{\"actor_id\":{\"type\":\"integer\",\"description\":\"The ID of the actor that can bypass a ruleset\"},\"actor_type\":{\"type\":\"string\",\"enum\":[\"Team\",\"Integration\"],\"description\":\"The type of actor that can bypass a ruleset\"}}}},\"node_id\":{\"type\":\"string\"},\"_links\":{\"type\":\"object\",\"properties\":{\"self\":{\"type\":\"object\",\"properties\":{\"href\":{\"type\":\"string\",\"description\":\"The URL of the ruleset\"}}}}},\"conditions\":{\"anyOf\":[{\"title\":\"Repository ruleset conditions for ref names\",\"type\":\"object\",\"description\":\"Parameters for a repository ruleset ref name condition\",\"properties\":{\"ref_name\":{\"type\":\"object\",\"properties\":{\"include\":{\"type\":\"array\",\"description\":\"Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.\",\"items\":{\"type\":\"string\"}},\"exclude\":{\"type\":\"array\",\"description\":\"Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.\",\"items\":{\"type\":\"string\"}}}}}},{\"title\":\"Organization ruleset conditions\",\"type\":\"object\",\"description\":\"Conditions for a organization ruleset\",\"allOf\":[{\"title\":\"Repository ruleset conditions for ref names\",\"type\":\"object\",\"description\":\"Parameters for a repository ruleset ref name condition\",\"properties\":{\"ref_name\":{\"type\":\"object\",\"properties\":{\"include\":{\"type\":\"array\",\"description\":\"Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.\",\"items\":{\"type\":\"string\"}},\"exclude\":{\"type\":\"array\",\"description\":\"Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.\",\"items\":{\"type\":\"string\"}}}}}},{\"title\":\"Repository ruleset conditions for repository names\",\"type\":\"object\",\"description\":\"Parameters for a repository name condition\",\"properties\":{\"repository_name\":{\"type\":\"object\",\"properties\":{\"include\":{\"type\":\"array\",\"description\":\"Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.\",\"items\":{\"type\":\"string\"}},\"exclude\":{\"type\":\"array\",\"description\":\"Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.\",\"items\":{\"type\":\"string\"}},\"protected\":{\"type\":\"boolean\",\"description\":\"Whether renaming of target repositories is prevented.\"}}}}}]}]},\"rules\":{\"type\":\"array\",\"items\":{\"title\":\"Repository Rule\",\"type\":\"object\",\"description\":\"A repository rule.\",\"oneOf\":[{\"title\":\"creation\",\"description\":\"Parameters to be used for the creation rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"creation\"]}}},{\"title\":\"update\",\"description\":\"Parameters to be used for the update rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"update\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"update_allows_fetch_and_merge\":{\"type\":\"boolean\",\"description\":\"Branch can pull changes from its upstream repository\"}},\"required\":[\"update_allows_fetch_and_merge\"]}}},{\"title\":\"deletion\",\"description\":\"Parameters to be used for the deletion rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"deletion\"]}}},{\"title\":\"required_linear_history\",\"description\":\"Parameters to be used for the required_linear_history rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"required_linear_history\"]}}},{\"title\":\"required_deployments\",\"description\":\"Parameters to be used for the required_deployments rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"required_deployments\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"required_deployment_environments\":{\"type\":\"array\",\"description\":\"The environments that must be successfully deployed to before branches can be merged.\",\"items\":{\"type\":\"string\"}}},\"required\":[\"required_deployment_environments\"]}}},{\"title\":\"required_signatures\",\"description\":\"Parameters to be used for the required_signatures rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"required_signatures\"]}}},{\"title\":\"pull_request\",\"description\":\"Parameters to be used for the pull_request rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"pull_request\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"dismiss_stale_reviews_on_push\":{\"type\":\"boolean\",\"description\":\"New, reviewable commits pushed will dismiss previous pull request review approvals.\"},\"require_code_owner_review\":{\"type\":\"boolean\",\"description\":\"Require an approving review in pull requests that modify files that have a designated code owner.\"},\"require_last_push_approval\":{\"type\":\"boolean\",\"description\":\"Whether the most recent reviewable push must be approved by someone other than the person who pushed it.\"},\"required_approving_review_count\":{\"type\":\"integer\",\"description\":\"The number of approving reviews that are required before a pull request can be merged.\",\"minimum\":0,\"maximum\":10},\"required_review_thread_resolution\":{\"type\":\"boolean\",\"description\":\"All conversations on code must be resolved before a pull request can be merged.\"}},\"required\":[\"dismiss_stale_reviews_on_push\",\"require_code_owner_review\",\"require_last_push_approval\",\"required_approving_review_count\",\"required_review_thread_resolution\"]}}},{\"title\":\"required_status_checks\",\"description\":\"Parameters to be used for the required_status_checks rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"required_status_checks\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"required_status_checks\":{\"type\":\"array\",\"description\":\"Status checks that are required.\",\"items\":{\"title\":\"StatusCheckConfiguration\",\"description\":\"Required status check\",\"type\":\"object\",\"properties\":{\"context\":{\"type\":\"string\",\"description\":\"The status check context name that must be present on the commit.\"},\"integration_id\":{\"type\":\"integer\",\"description\":\"The optional integration ID that this status check must originate from.\"}},\"required\":[\"context\"]}},\"strict_required_status_checks_policy\":{\"type\":\"boolean\",\"description\":\"Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled.\"}},\"required\":[\"required_status_checks\",\"strict_required_status_checks_policy\"]}}},{\"title\":\"non_fast_forward\",\"description\":\"Parameters to be used for the non_fast_forward rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"non_fast_forward\"]}}},{\"title\":\"commit_message_pattern\",\"description\":\"Parameters to be used for the commit_message_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"commit_message_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}},{\"title\":\"commit_author_email_pattern\",\"description\":\"Parameters to be used for the commit_author_email_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"commit_author_email_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}},{\"title\":\"committer_email_pattern\",\"description\":\"Parameters to be used for the committer_email_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"committer_email_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}},{\"title\":\"branch_name_pattern\",\"description\":\"Parameters to be used for the branch_name_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"branch_name_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}},{\"title\":\"tag_name_pattern\",\"description\":\"Parameters to be used for the tag_name_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"tag_name_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}}]}}}}}" + "schema": "{\"type\":\"array\",\"items\":{\"title\":\"Repository ruleset\",\"type\":\"object\",\"description\":\"A set of rules to apply when specified conditions are met.\",\"required\":[\"id\",\"name\",\"source\",\"enforcement\"],\"properties\":{\"id\":{\"type\":\"integer\",\"description\":\"The ID of the ruleset\"},\"name\":{\"type\":\"string\",\"description\":\"The name of the ruleset\"},\"target\":{\"type\":\"string\",\"description\":\"The target of the ruleset\",\"enum\":[\"branch\",\"tag\"]},\"source_type\":{\"type\":\"string\",\"description\":\"The type of the source of the ruleset\",\"enum\":[\"Repository\",\"Organization\"]},\"source\":{\"type\":\"string\",\"description\":\"The name of the source\"},\"enforcement\":{\"type\":\"string\",\"description\":\"The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise).\",\"enum\":[\"disabled\",\"active\",\"evaluate\"]},\"bypass_mode\":{\"type\":\"string\",\"description\":\"The permission level required to bypass this ruleset. \\\"repository\\\" allows those with bypass permission at the repository level to bypass. \\\"organization\\\" allows those with bypass permission at the organization level to bypass. \\\"none\\\" prevents anyone from bypassing.\",\"enum\":[\"none\",\"repository\",\"organization\"]},\"bypass_actors\":{\"type\":\"array\",\"description\":\"The actors that can bypass the rules in this ruleset\",\"items\":{\"title\":\"Repository Ruleset Bypass Actor\",\"type\":\"object\",\"description\":\"An actor that can bypass rules in a ruleset\",\"properties\":{\"actor_id\":{\"type\":\"integer\",\"description\":\"The ID of the actor that can bypass a ruleset\"},\"actor_type\":{\"type\":\"string\",\"enum\":[\"Team\",\"Integration\"],\"description\":\"The type of actor that can bypass a ruleset\"}}}},\"node_id\":{\"type\":\"string\"},\"_links\":{\"type\":\"object\",\"properties\":{\"self\":{\"type\":\"object\",\"properties\":{\"href\":{\"type\":\"string\",\"description\":\"The URL of the ruleset\"}}},\"html\":{\"type\":\"object\",\"properties\":{\"href\":{\"type\":\"string\",\"description\":\"The html URL of the ruleset\"}}}}},\"conditions\":{\"anyOf\":[{\"title\":\"Repository ruleset conditions for ref names\",\"type\":\"object\",\"description\":\"Parameters for a repository ruleset ref name condition\",\"properties\":{\"ref_name\":{\"type\":\"object\",\"properties\":{\"include\":{\"type\":\"array\",\"description\":\"Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.\",\"items\":{\"type\":\"string\"}},\"exclude\":{\"type\":\"array\",\"description\":\"Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.\",\"items\":{\"type\":\"string\"}}}}}},{\"title\":\"Organization ruleset conditions\",\"type\":\"object\",\"description\":\"Conditions for a organization ruleset\",\"allOf\":[{\"title\":\"Repository ruleset conditions for ref names\",\"type\":\"object\",\"description\":\"Parameters for a repository ruleset ref name condition\",\"properties\":{\"ref_name\":{\"type\":\"object\",\"properties\":{\"include\":{\"type\":\"array\",\"description\":\"Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.\",\"items\":{\"type\":\"string\"}},\"exclude\":{\"type\":\"array\",\"description\":\"Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.\",\"items\":{\"type\":\"string\"}}}}}},{\"title\":\"Repository ruleset conditions for repository names\",\"type\":\"object\",\"description\":\"Parameters for a repository name condition\",\"properties\":{\"repository_name\":{\"type\":\"object\",\"properties\":{\"include\":{\"type\":\"array\",\"description\":\"Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.\",\"items\":{\"type\":\"string\"}},\"exclude\":{\"type\":\"array\",\"description\":\"Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.\",\"items\":{\"type\":\"string\"}},\"protected\":{\"type\":\"boolean\",\"description\":\"Whether renaming of target repositories is prevented.\"}}}}}]}]},\"rules\":{\"type\":\"array\",\"items\":{\"title\":\"Repository Rule\",\"type\":\"object\",\"description\":\"A repository rule.\",\"oneOf\":[{\"title\":\"creation\",\"description\":\"Only allow users with bypass permission to create matching refs.\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"creation\"]}}},{\"title\":\"update\",\"description\":\"Only allow users with bypass permission to update matching refs.\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"update\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"update_allows_fetch_and_merge\":{\"type\":\"boolean\",\"description\":\"Branch can pull changes from its upstream repository\"}},\"required\":[\"update_allows_fetch_and_merge\"]}}},{\"title\":\"deletion\",\"description\":\"Only allow users with bypass permissions to delete matching refs.\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"deletion\"]}}},{\"title\":\"required_linear_history\",\"description\":\"Prevent merge commits from being pushed to matching branches.\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"required_linear_history\"]}}},{\"title\":\"required_deployments\",\"description\":\"Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule.\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"required_deployments\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"required_deployment_environments\":{\"type\":\"array\",\"description\":\"The environments that must be successfully deployed to before branches can be merged.\",\"items\":{\"type\":\"string\"}}},\"required\":[\"required_deployment_environments\"]}}},{\"title\":\"required_signatures\",\"description\":\"Commits pushed to matching branches must have verified signatures.\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"required_signatures\"]}}},{\"title\":\"pull_request\",\"description\":\"Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"pull_request\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"dismiss_stale_reviews_on_push\":{\"type\":\"boolean\",\"description\":\"New, reviewable commits pushed will dismiss previous pull request review approvals.\"},\"require_code_owner_review\":{\"type\":\"boolean\",\"description\":\"Require an approving review in pull requests that modify files that have a designated code owner.\"},\"require_last_push_approval\":{\"type\":\"boolean\",\"description\":\"Whether the most recent reviewable push must be approved by someone other than the person who pushed it.\"},\"required_approving_review_count\":{\"type\":\"integer\",\"description\":\"The number of approving reviews that are required before a pull request can be merged.\",\"minimum\":0,\"maximum\":10},\"required_review_thread_resolution\":{\"type\":\"boolean\",\"description\":\"All conversations on code must be resolved before a pull request can be merged.\"}},\"required\":[\"dismiss_stale_reviews_on_push\",\"require_code_owner_review\",\"require_last_push_approval\",\"required_approving_review_count\",\"required_review_thread_resolution\"]}}},{\"title\":\"required_status_checks\",\"description\":\"Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"required_status_checks\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"required_status_checks\":{\"type\":\"array\",\"description\":\"Status checks that are required.\",\"items\":{\"title\":\"StatusCheckConfiguration\",\"description\":\"Required status check\",\"type\":\"object\",\"properties\":{\"context\":{\"type\":\"string\",\"description\":\"The status check context name that must be present on the commit.\"},\"integration_id\":{\"type\":\"integer\",\"description\":\"The optional integration ID that this status check must originate from.\"}},\"required\":[\"context\"]}},\"strict_required_status_checks_policy\":{\"type\":\"boolean\",\"description\":\"Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled.\"}},\"required\":[\"required_status_checks\",\"strict_required_status_checks_policy\"]}}},{\"title\":\"non_fast_forward\",\"description\":\"Prevent users with push access from force pushing to branches.\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"non_fast_forward\"]}}},{\"title\":\"commit_message_pattern\",\"description\":\"Parameters to be used for the commit_message_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"commit_message_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}},{\"title\":\"commit_author_email_pattern\",\"description\":\"Parameters to be used for the commit_author_email_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"commit_author_email_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}},{\"title\":\"committer_email_pattern\",\"description\":\"Parameters to be used for the committer_email_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"committer_email_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}},{\"title\":\"branch_name_pattern\",\"description\":\"Parameters to be used for the branch_name_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"branch_name_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}},{\"title\":\"tag_name_pattern\",\"description\":\"Parameters to be used for the tag_name_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"tag_name_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}}]}},\"created_at\":{\"type\":\"string\",\"format\":\"date-time\"},\"updated_at\":{\"type\":\"string\",\"format\":\"date-time\"}}}}" }, { "code": 404, @@ -15979,6 +16054,8 @@ "parameters": [ { "name": "owner" }, { "name": "repo" }, + { "name": "per_page" }, + { "name": "page" }, { "name": "includes_parents" } ] }, @@ -16820,6 +16897,10 @@ { "code": 200, "schema": "{\"type\":\"array\",\"items\":{\"title\":\"Team\",\"description\":\"Groups of organization members that gives permissions on specified repositories.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"integer\"},\"node_id\":{\"type\":\"string\"},\"name\":{\"type\":\"string\"},\"slug\":{\"type\":\"string\"},\"description\":{\"type\":\"string\",\"nullable\":true},\"privacy\":{\"type\":\"string\"},\"notification_setting\":{\"type\":\"string\"},\"permission\":{\"type\":\"string\"},\"permissions\":{\"type\":\"object\",\"properties\":{\"pull\":{\"type\":\"boolean\"},\"triage\":{\"type\":\"boolean\"},\"push\":{\"type\":\"boolean\"},\"maintain\":{\"type\":\"boolean\"},\"admin\":{\"type\":\"boolean\"}},\"required\":[\"pull\",\"triage\",\"push\",\"maintain\",\"admin\"]},\"url\":{\"type\":\"string\",\"format\":\"uri\"},\"html_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://github.com/orgs/rails/teams/core\"},\"members_url\":{\"type\":\"string\"},\"repositories_url\":{\"type\":\"string\",\"format\":\"uri\"},\"parent\":{\"title\":\"Team Simple\",\"description\":\"Groups of organization members that gives permissions on specified repositories.\",\"type\":\"object\",\"properties\":{\"id\":{\"description\":\"Unique identifier of the team\",\"type\":\"integer\",\"example\":1},\"node_id\":{\"type\":\"string\",\"example\":\"MDQ6VGVhbTE=\"},\"url\":{\"description\":\"URL for the team\",\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/organizations/1/team/1\"},\"members_url\":{\"type\":\"string\",\"example\":\"https://api.github.com/organizations/1/team/1/members{/member}\"},\"name\":{\"description\":\"Name of the team\",\"type\":\"string\",\"example\":\"Justice League\"},\"description\":{\"description\":\"Description of the team\",\"type\":\"string\",\"nullable\":true,\"example\":\"A great team.\"},\"permission\":{\"description\":\"Permission that the team will have for its repositories\",\"type\":\"string\",\"example\":\"admin\"},\"privacy\":{\"description\":\"The level of privacy this team should have\",\"type\":\"string\",\"example\":\"closed\"},\"notification_setting\":{\"description\":\"The notification setting the team has set\",\"type\":\"string\",\"example\":\"notifications_enabled\"},\"html_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://github.com/orgs/rails/teams/core\"},\"repositories_url\":{\"type\":\"string\",\"format\":\"uri\",\"example\":\"https://api.github.com/organizations/1/team/1/repos\"},\"slug\":{\"type\":\"string\",\"example\":\"justice-league\"},\"ldap_dn\":{\"description\":\"Distinguished Name (DN) that team maps to within LDAP environment\",\"example\":\"uid=example,ou=users,dc=github,dc=com\",\"type\":\"string\"}},\"required\":[\"id\",\"node_id\",\"url\",\"members_url\",\"name\",\"description\",\"permission\",\"html_url\",\"repositories_url\",\"slug\"],\"nullable\":true}},\"required\":[\"id\",\"node_id\",\"url\",\"members_url\",\"name\",\"description\",\"permission\",\"html_url\",\"repositories_url\",\"slug\",\"parent\"]}}" + }, + { + "code": 404, + "schema": "{\"title\":\"Basic Error\",\"description\":\"Basic Error\",\"type\":\"object\",\"properties\":{\"message\":{\"type\":\"string\"},\"documentation_url\":{\"type\":\"string\"},\"url\":{\"type\":\"string\"},\"status\":{\"type\":\"string\"}}}" } ], "parameters": [ @@ -17012,7 +17093,17 @@ "scope": "repos", "documentationUrl": "https://docs.github.com/rest/collaborators/collaborators#remove-a-repository-collaborator", "renamed": null, - "responses": [{ "code": 204, "schema": null }], + "responses": [ + { "code": 204, "schema": null }, + { + "code": 403, + "schema": "{\"title\":\"Basic Error\",\"description\":\"Basic Error\",\"type\":\"object\",\"properties\":{\"message\":{\"type\":\"string\"},\"documentation_url\":{\"type\":\"string\"},\"url\":{\"type\":\"string\"},\"status\":{\"type\":\"string\"}}}" + }, + { + "code": 422, + "schema": "{\"title\":\"Validation Error\",\"description\":\"Validation Error\",\"type\":\"object\",\"required\":[\"message\",\"documentation_url\"],\"properties\":{\"message\":{\"type\":\"string\"},\"documentation_url\":{\"type\":\"string\"},\"errors\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"required\":[\"code\"],\"properties\":{\"resource\":{\"type\":\"string\"},\"field\":{\"type\":\"string\"},\"message\":{\"type\":\"string\"},\"code\":{\"type\":\"string\"},\"index\":{\"type\":\"integer\"},\"value\":{\"oneOf\":[{\"type\":\"string\",\"nullable\":true},{\"type\":\"integer\",\"nullable\":true},{\"type\":\"array\",\"nullable\":true,\"items\":{\"type\":\"string\"}}]}}}}}}" + } + ], "parameters": [ { "name": "owner" }, { "name": "repo" }, @@ -17567,7 +17658,7 @@ "responses": [ { "code": 200, - "schema": "{\"title\":\"Repository ruleset\",\"type\":\"object\",\"description\":\"A set of rules to apply when specified conditions are met.\",\"required\":[\"id\",\"name\",\"source\",\"enforcement\"],\"properties\":{\"id\":{\"type\":\"integer\",\"description\":\"The ID of the ruleset\"},\"name\":{\"type\":\"string\",\"description\":\"The name of the ruleset\"},\"target\":{\"type\":\"string\",\"description\":\"The target of the ruleset\",\"enum\":[\"branch\",\"tag\"]},\"source_type\":{\"type\":\"string\",\"description\":\"The type of the source of the ruleset\",\"enum\":[\"Repository\",\"Organization\"]},\"source\":{\"type\":\"string\",\"description\":\"The name of the source\"},\"enforcement\":{\"type\":\"string\",\"description\":\"The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise).\",\"enum\":[\"disabled\",\"active\",\"evaluate\"]},\"bypass_mode\":{\"type\":\"string\",\"description\":\"The permission level required to bypass this ruleset. \\\"repository\\\" allows those with bypass permission at the repository level to bypass. \\\"organization\\\" allows those with bypass permission at the organization level to bypass. \\\"none\\\" prevents anyone from bypassing.\",\"enum\":[\"none\",\"repository\",\"organization\"]},\"bypass_actors\":{\"type\":\"array\",\"description\":\"The actors that can bypass the rules in this ruleset\",\"items\":{\"title\":\"Repository Ruleset Bypass Actor\",\"type\":\"object\",\"description\":\"An actor that can bypass rules in a ruleset\",\"properties\":{\"actor_id\":{\"type\":\"integer\",\"description\":\"The ID of the actor that can bypass a ruleset\"},\"actor_type\":{\"type\":\"string\",\"enum\":[\"Team\",\"Integration\"],\"description\":\"The type of actor that can bypass a ruleset\"}}}},\"node_id\":{\"type\":\"string\"},\"_links\":{\"type\":\"object\",\"properties\":{\"self\":{\"type\":\"object\",\"properties\":{\"href\":{\"type\":\"string\",\"description\":\"The URL of the ruleset\"}}}}},\"conditions\":{\"anyOf\":[{\"title\":\"Repository ruleset conditions for ref names\",\"type\":\"object\",\"description\":\"Parameters for a repository ruleset ref name condition\",\"properties\":{\"ref_name\":{\"type\":\"object\",\"properties\":{\"include\":{\"type\":\"array\",\"description\":\"Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.\",\"items\":{\"type\":\"string\"}},\"exclude\":{\"type\":\"array\",\"description\":\"Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.\",\"items\":{\"type\":\"string\"}}}}}},{\"title\":\"Organization ruleset conditions\",\"type\":\"object\",\"description\":\"Conditions for a organization ruleset\",\"allOf\":[{\"title\":\"Repository ruleset conditions for ref names\",\"type\":\"object\",\"description\":\"Parameters for a repository ruleset ref name condition\",\"properties\":{\"ref_name\":{\"type\":\"object\",\"properties\":{\"include\":{\"type\":\"array\",\"description\":\"Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.\",\"items\":{\"type\":\"string\"}},\"exclude\":{\"type\":\"array\",\"description\":\"Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.\",\"items\":{\"type\":\"string\"}}}}}},{\"title\":\"Repository ruleset conditions for repository names\",\"type\":\"object\",\"description\":\"Parameters for a repository name condition\",\"properties\":{\"repository_name\":{\"type\":\"object\",\"properties\":{\"include\":{\"type\":\"array\",\"description\":\"Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.\",\"items\":{\"type\":\"string\"}},\"exclude\":{\"type\":\"array\",\"description\":\"Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.\",\"items\":{\"type\":\"string\"}},\"protected\":{\"type\":\"boolean\",\"description\":\"Whether renaming of target repositories is prevented.\"}}}}}]}]},\"rules\":{\"type\":\"array\",\"items\":{\"title\":\"Repository Rule\",\"type\":\"object\",\"description\":\"A repository rule.\",\"oneOf\":[{\"title\":\"creation\",\"description\":\"Parameters to be used for the creation rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"creation\"]}}},{\"title\":\"update\",\"description\":\"Parameters to be used for the update rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"update\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"update_allows_fetch_and_merge\":{\"type\":\"boolean\",\"description\":\"Branch can pull changes from its upstream repository\"}},\"required\":[\"update_allows_fetch_and_merge\"]}}},{\"title\":\"deletion\",\"description\":\"Parameters to be used for the deletion rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"deletion\"]}}},{\"title\":\"required_linear_history\",\"description\":\"Parameters to be used for the required_linear_history rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"required_linear_history\"]}}},{\"title\":\"required_deployments\",\"description\":\"Parameters to be used for the required_deployments rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"required_deployments\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"required_deployment_environments\":{\"type\":\"array\",\"description\":\"The environments that must be successfully deployed to before branches can be merged.\",\"items\":{\"type\":\"string\"}}},\"required\":[\"required_deployment_environments\"]}}},{\"title\":\"required_signatures\",\"description\":\"Parameters to be used for the required_signatures rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"required_signatures\"]}}},{\"title\":\"pull_request\",\"description\":\"Parameters to be used for the pull_request rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"pull_request\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"dismiss_stale_reviews_on_push\":{\"type\":\"boolean\",\"description\":\"New, reviewable commits pushed will dismiss previous pull request review approvals.\"},\"require_code_owner_review\":{\"type\":\"boolean\",\"description\":\"Require an approving review in pull requests that modify files that have a designated code owner.\"},\"require_last_push_approval\":{\"type\":\"boolean\",\"description\":\"Whether the most recent reviewable push must be approved by someone other than the person who pushed it.\"},\"required_approving_review_count\":{\"type\":\"integer\",\"description\":\"The number of approving reviews that are required before a pull request can be merged.\",\"minimum\":0,\"maximum\":10},\"required_review_thread_resolution\":{\"type\":\"boolean\",\"description\":\"All conversations on code must be resolved before a pull request can be merged.\"}},\"required\":[\"dismiss_stale_reviews_on_push\",\"require_code_owner_review\",\"require_last_push_approval\",\"required_approving_review_count\",\"required_review_thread_resolution\"]}}},{\"title\":\"required_status_checks\",\"description\":\"Parameters to be used for the required_status_checks rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"required_status_checks\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"required_status_checks\":{\"type\":\"array\",\"description\":\"Status checks that are required.\",\"items\":{\"title\":\"StatusCheckConfiguration\",\"description\":\"Required status check\",\"type\":\"object\",\"properties\":{\"context\":{\"type\":\"string\",\"description\":\"The status check context name that must be present on the commit.\"},\"integration_id\":{\"type\":\"integer\",\"description\":\"The optional integration ID that this status check must originate from.\"}},\"required\":[\"context\"]}},\"strict_required_status_checks_policy\":{\"type\":\"boolean\",\"description\":\"Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled.\"}},\"required\":[\"required_status_checks\",\"strict_required_status_checks_policy\"]}}},{\"title\":\"non_fast_forward\",\"description\":\"Parameters to be used for the non_fast_forward rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"non_fast_forward\"]}}},{\"title\":\"commit_message_pattern\",\"description\":\"Parameters to be used for the commit_message_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"commit_message_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}},{\"title\":\"commit_author_email_pattern\",\"description\":\"Parameters to be used for the commit_author_email_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"commit_author_email_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}},{\"title\":\"committer_email_pattern\",\"description\":\"Parameters to be used for the committer_email_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"committer_email_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}},{\"title\":\"branch_name_pattern\",\"description\":\"Parameters to be used for the branch_name_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"branch_name_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}},{\"title\":\"tag_name_pattern\",\"description\":\"Parameters to be used for the tag_name_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"tag_name_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}}]}}}}" + "schema": "{\"title\":\"Repository ruleset\",\"type\":\"object\",\"description\":\"A set of rules to apply when specified conditions are met.\",\"required\":[\"id\",\"name\",\"source\",\"enforcement\"],\"properties\":{\"id\":{\"type\":\"integer\",\"description\":\"The ID of the ruleset\"},\"name\":{\"type\":\"string\",\"description\":\"The name of the ruleset\"},\"target\":{\"type\":\"string\",\"description\":\"The target of the ruleset\",\"enum\":[\"branch\",\"tag\"]},\"source_type\":{\"type\":\"string\",\"description\":\"The type of the source of the ruleset\",\"enum\":[\"Repository\",\"Organization\"]},\"source\":{\"type\":\"string\",\"description\":\"The name of the source\"},\"enforcement\":{\"type\":\"string\",\"description\":\"The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise).\",\"enum\":[\"disabled\",\"active\",\"evaluate\"]},\"bypass_mode\":{\"type\":\"string\",\"description\":\"The permission level required to bypass this ruleset. \\\"repository\\\" allows those with bypass permission at the repository level to bypass. \\\"organization\\\" allows those with bypass permission at the organization level to bypass. \\\"none\\\" prevents anyone from bypassing.\",\"enum\":[\"none\",\"repository\",\"organization\"]},\"bypass_actors\":{\"type\":\"array\",\"description\":\"The actors that can bypass the rules in this ruleset\",\"items\":{\"title\":\"Repository Ruleset Bypass Actor\",\"type\":\"object\",\"description\":\"An actor that can bypass rules in a ruleset\",\"properties\":{\"actor_id\":{\"type\":\"integer\",\"description\":\"The ID of the actor that can bypass a ruleset\"},\"actor_type\":{\"type\":\"string\",\"enum\":[\"Team\",\"Integration\"],\"description\":\"The type of actor that can bypass a ruleset\"}}}},\"node_id\":{\"type\":\"string\"},\"_links\":{\"type\":\"object\",\"properties\":{\"self\":{\"type\":\"object\",\"properties\":{\"href\":{\"type\":\"string\",\"description\":\"The URL of the ruleset\"}}},\"html\":{\"type\":\"object\",\"properties\":{\"href\":{\"type\":\"string\",\"description\":\"The html URL of the ruleset\"}}}}},\"conditions\":{\"anyOf\":[{\"title\":\"Repository ruleset conditions for ref names\",\"type\":\"object\",\"description\":\"Parameters for a repository ruleset ref name condition\",\"properties\":{\"ref_name\":{\"type\":\"object\",\"properties\":{\"include\":{\"type\":\"array\",\"description\":\"Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.\",\"items\":{\"type\":\"string\"}},\"exclude\":{\"type\":\"array\",\"description\":\"Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.\",\"items\":{\"type\":\"string\"}}}}}},{\"title\":\"Organization ruleset conditions\",\"type\":\"object\",\"description\":\"Conditions for a organization ruleset\",\"allOf\":[{\"title\":\"Repository ruleset conditions for ref names\",\"type\":\"object\",\"description\":\"Parameters for a repository ruleset ref name condition\",\"properties\":{\"ref_name\":{\"type\":\"object\",\"properties\":{\"include\":{\"type\":\"array\",\"description\":\"Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.\",\"items\":{\"type\":\"string\"}},\"exclude\":{\"type\":\"array\",\"description\":\"Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.\",\"items\":{\"type\":\"string\"}}}}}},{\"title\":\"Repository ruleset conditions for repository names\",\"type\":\"object\",\"description\":\"Parameters for a repository name condition\",\"properties\":{\"repository_name\":{\"type\":\"object\",\"properties\":{\"include\":{\"type\":\"array\",\"description\":\"Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.\",\"items\":{\"type\":\"string\"}},\"exclude\":{\"type\":\"array\",\"description\":\"Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.\",\"items\":{\"type\":\"string\"}},\"protected\":{\"type\":\"boolean\",\"description\":\"Whether renaming of target repositories is prevented.\"}}}}}]}]},\"rules\":{\"type\":\"array\",\"items\":{\"title\":\"Repository Rule\",\"type\":\"object\",\"description\":\"A repository rule.\",\"oneOf\":[{\"title\":\"creation\",\"description\":\"Only allow users with bypass permission to create matching refs.\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"creation\"]}}},{\"title\":\"update\",\"description\":\"Only allow users with bypass permission to update matching refs.\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"update\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"update_allows_fetch_and_merge\":{\"type\":\"boolean\",\"description\":\"Branch can pull changes from its upstream repository\"}},\"required\":[\"update_allows_fetch_and_merge\"]}}},{\"title\":\"deletion\",\"description\":\"Only allow users with bypass permissions to delete matching refs.\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"deletion\"]}}},{\"title\":\"required_linear_history\",\"description\":\"Prevent merge commits from being pushed to matching branches.\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"required_linear_history\"]}}},{\"title\":\"required_deployments\",\"description\":\"Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule.\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"required_deployments\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"required_deployment_environments\":{\"type\":\"array\",\"description\":\"The environments that must be successfully deployed to before branches can be merged.\",\"items\":{\"type\":\"string\"}}},\"required\":[\"required_deployment_environments\"]}}},{\"title\":\"required_signatures\",\"description\":\"Commits pushed to matching branches must have verified signatures.\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"required_signatures\"]}}},{\"title\":\"pull_request\",\"description\":\"Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"pull_request\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"dismiss_stale_reviews_on_push\":{\"type\":\"boolean\",\"description\":\"New, reviewable commits pushed will dismiss previous pull request review approvals.\"},\"require_code_owner_review\":{\"type\":\"boolean\",\"description\":\"Require an approving review in pull requests that modify files that have a designated code owner.\"},\"require_last_push_approval\":{\"type\":\"boolean\",\"description\":\"Whether the most recent reviewable push must be approved by someone other than the person who pushed it.\"},\"required_approving_review_count\":{\"type\":\"integer\",\"description\":\"The number of approving reviews that are required before a pull request can be merged.\",\"minimum\":0,\"maximum\":10},\"required_review_thread_resolution\":{\"type\":\"boolean\",\"description\":\"All conversations on code must be resolved before a pull request can be merged.\"}},\"required\":[\"dismiss_stale_reviews_on_push\",\"require_code_owner_review\",\"require_last_push_approval\",\"required_approving_review_count\",\"required_review_thread_resolution\"]}}},{\"title\":\"required_status_checks\",\"description\":\"Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"required_status_checks\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"required_status_checks\":{\"type\":\"array\",\"description\":\"Status checks that are required.\",\"items\":{\"title\":\"StatusCheckConfiguration\",\"description\":\"Required status check\",\"type\":\"object\",\"properties\":{\"context\":{\"type\":\"string\",\"description\":\"The status check context name that must be present on the commit.\"},\"integration_id\":{\"type\":\"integer\",\"description\":\"The optional integration ID that this status check must originate from.\"}},\"required\":[\"context\"]}},\"strict_required_status_checks_policy\":{\"type\":\"boolean\",\"description\":\"Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled.\"}},\"required\":[\"required_status_checks\",\"strict_required_status_checks_policy\"]}}},{\"title\":\"non_fast_forward\",\"description\":\"Prevent users with push access from force pushing to branches.\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"non_fast_forward\"]}}},{\"title\":\"commit_message_pattern\",\"description\":\"Parameters to be used for the commit_message_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"commit_message_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}},{\"title\":\"commit_author_email_pattern\",\"description\":\"Parameters to be used for the commit_author_email_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"commit_author_email_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}},{\"title\":\"committer_email_pattern\",\"description\":\"Parameters to be used for the committer_email_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"committer_email_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}},{\"title\":\"branch_name_pattern\",\"description\":\"Parameters to be used for the branch_name_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"branch_name_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}},{\"title\":\"tag_name_pattern\",\"description\":\"Parameters to be used for the tag_name_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"tag_name_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}}]}},\"created_at\":{\"type\":\"string\",\"format\":\"date-time\"},\"updated_at\":{\"type\":\"string\",\"format\":\"date-time\"}}}" }, { "code": 404, @@ -17702,7 +17793,7 @@ "responses": [ { "code": 200, - "schema": "{\"title\":\"Repository ruleset\",\"type\":\"object\",\"description\":\"A set of rules to apply when specified conditions are met.\",\"required\":[\"id\",\"name\",\"source\",\"enforcement\"],\"properties\":{\"id\":{\"type\":\"integer\",\"description\":\"The ID of the ruleset\"},\"name\":{\"type\":\"string\",\"description\":\"The name of the ruleset\"},\"target\":{\"type\":\"string\",\"description\":\"The target of the ruleset\",\"enum\":[\"branch\",\"tag\"]},\"source_type\":{\"type\":\"string\",\"description\":\"The type of the source of the ruleset\",\"enum\":[\"Repository\",\"Organization\"]},\"source\":{\"type\":\"string\",\"description\":\"The name of the source\"},\"enforcement\":{\"type\":\"string\",\"description\":\"The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise).\",\"enum\":[\"disabled\",\"active\",\"evaluate\"]},\"bypass_mode\":{\"type\":\"string\",\"description\":\"The permission level required to bypass this ruleset. \\\"repository\\\" allows those with bypass permission at the repository level to bypass. \\\"organization\\\" allows those with bypass permission at the organization level to bypass. \\\"none\\\" prevents anyone from bypassing.\",\"enum\":[\"none\",\"repository\",\"organization\"]},\"bypass_actors\":{\"type\":\"array\",\"description\":\"The actors that can bypass the rules in this ruleset\",\"items\":{\"title\":\"Repository Ruleset Bypass Actor\",\"type\":\"object\",\"description\":\"An actor that can bypass rules in a ruleset\",\"properties\":{\"actor_id\":{\"type\":\"integer\",\"description\":\"The ID of the actor that can bypass a ruleset\"},\"actor_type\":{\"type\":\"string\",\"enum\":[\"Team\",\"Integration\"],\"description\":\"The type of actor that can bypass a ruleset\"}}}},\"node_id\":{\"type\":\"string\"},\"_links\":{\"type\":\"object\",\"properties\":{\"self\":{\"type\":\"object\",\"properties\":{\"href\":{\"type\":\"string\",\"description\":\"The URL of the ruleset\"}}}}},\"conditions\":{\"anyOf\":[{\"title\":\"Repository ruleset conditions for ref names\",\"type\":\"object\",\"description\":\"Parameters for a repository ruleset ref name condition\",\"properties\":{\"ref_name\":{\"type\":\"object\",\"properties\":{\"include\":{\"type\":\"array\",\"description\":\"Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.\",\"items\":{\"type\":\"string\"}},\"exclude\":{\"type\":\"array\",\"description\":\"Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.\",\"items\":{\"type\":\"string\"}}}}}},{\"title\":\"Organization ruleset conditions\",\"type\":\"object\",\"description\":\"Conditions for a organization ruleset\",\"allOf\":[{\"title\":\"Repository ruleset conditions for ref names\",\"type\":\"object\",\"description\":\"Parameters for a repository ruleset ref name condition\",\"properties\":{\"ref_name\":{\"type\":\"object\",\"properties\":{\"include\":{\"type\":\"array\",\"description\":\"Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.\",\"items\":{\"type\":\"string\"}},\"exclude\":{\"type\":\"array\",\"description\":\"Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.\",\"items\":{\"type\":\"string\"}}}}}},{\"title\":\"Repository ruleset conditions for repository names\",\"type\":\"object\",\"description\":\"Parameters for a repository name condition\",\"properties\":{\"repository_name\":{\"type\":\"object\",\"properties\":{\"include\":{\"type\":\"array\",\"description\":\"Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.\",\"items\":{\"type\":\"string\"}},\"exclude\":{\"type\":\"array\",\"description\":\"Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.\",\"items\":{\"type\":\"string\"}},\"protected\":{\"type\":\"boolean\",\"description\":\"Whether renaming of target repositories is prevented.\"}}}}}]}]},\"rules\":{\"type\":\"array\",\"items\":{\"title\":\"Repository Rule\",\"type\":\"object\",\"description\":\"A repository rule.\",\"oneOf\":[{\"title\":\"creation\",\"description\":\"Parameters to be used for the creation rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"creation\"]}}},{\"title\":\"update\",\"description\":\"Parameters to be used for the update rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"update\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"update_allows_fetch_and_merge\":{\"type\":\"boolean\",\"description\":\"Branch can pull changes from its upstream repository\"}},\"required\":[\"update_allows_fetch_and_merge\"]}}},{\"title\":\"deletion\",\"description\":\"Parameters to be used for the deletion rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"deletion\"]}}},{\"title\":\"required_linear_history\",\"description\":\"Parameters to be used for the required_linear_history rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"required_linear_history\"]}}},{\"title\":\"required_deployments\",\"description\":\"Parameters to be used for the required_deployments rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"required_deployments\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"required_deployment_environments\":{\"type\":\"array\",\"description\":\"The environments that must be successfully deployed to before branches can be merged.\",\"items\":{\"type\":\"string\"}}},\"required\":[\"required_deployment_environments\"]}}},{\"title\":\"required_signatures\",\"description\":\"Parameters to be used for the required_signatures rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"required_signatures\"]}}},{\"title\":\"pull_request\",\"description\":\"Parameters to be used for the pull_request rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"pull_request\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"dismiss_stale_reviews_on_push\":{\"type\":\"boolean\",\"description\":\"New, reviewable commits pushed will dismiss previous pull request review approvals.\"},\"require_code_owner_review\":{\"type\":\"boolean\",\"description\":\"Require an approving review in pull requests that modify files that have a designated code owner.\"},\"require_last_push_approval\":{\"type\":\"boolean\",\"description\":\"Whether the most recent reviewable push must be approved by someone other than the person who pushed it.\"},\"required_approving_review_count\":{\"type\":\"integer\",\"description\":\"The number of approving reviews that are required before a pull request can be merged.\",\"minimum\":0,\"maximum\":10},\"required_review_thread_resolution\":{\"type\":\"boolean\",\"description\":\"All conversations on code must be resolved before a pull request can be merged.\"}},\"required\":[\"dismiss_stale_reviews_on_push\",\"require_code_owner_review\",\"require_last_push_approval\",\"required_approving_review_count\",\"required_review_thread_resolution\"]}}},{\"title\":\"required_status_checks\",\"description\":\"Parameters to be used for the required_status_checks rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"required_status_checks\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"required_status_checks\":{\"type\":\"array\",\"description\":\"Status checks that are required.\",\"items\":{\"title\":\"StatusCheckConfiguration\",\"description\":\"Required status check\",\"type\":\"object\",\"properties\":{\"context\":{\"type\":\"string\",\"description\":\"The status check context name that must be present on the commit.\"},\"integration_id\":{\"type\":\"integer\",\"description\":\"The optional integration ID that this status check must originate from.\"}},\"required\":[\"context\"]}},\"strict_required_status_checks_policy\":{\"type\":\"boolean\",\"description\":\"Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled.\"}},\"required\":[\"required_status_checks\",\"strict_required_status_checks_policy\"]}}},{\"title\":\"non_fast_forward\",\"description\":\"Parameters to be used for the non_fast_forward rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"non_fast_forward\"]}}},{\"title\":\"commit_message_pattern\",\"description\":\"Parameters to be used for the commit_message_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"commit_message_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}},{\"title\":\"commit_author_email_pattern\",\"description\":\"Parameters to be used for the commit_author_email_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"commit_author_email_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}},{\"title\":\"committer_email_pattern\",\"description\":\"Parameters to be used for the committer_email_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"committer_email_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}},{\"title\":\"branch_name_pattern\",\"description\":\"Parameters to be used for the branch_name_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"branch_name_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}},{\"title\":\"tag_name_pattern\",\"description\":\"Parameters to be used for the tag_name_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"tag_name_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}}]}}}}" + "schema": "{\"title\":\"Repository ruleset\",\"type\":\"object\",\"description\":\"A set of rules to apply when specified conditions are met.\",\"required\":[\"id\",\"name\",\"source\",\"enforcement\"],\"properties\":{\"id\":{\"type\":\"integer\",\"description\":\"The ID of the ruleset\"},\"name\":{\"type\":\"string\",\"description\":\"The name of the ruleset\"},\"target\":{\"type\":\"string\",\"description\":\"The target of the ruleset\",\"enum\":[\"branch\",\"tag\"]},\"source_type\":{\"type\":\"string\",\"description\":\"The type of the source of the ruleset\",\"enum\":[\"Repository\",\"Organization\"]},\"source\":{\"type\":\"string\",\"description\":\"The name of the source\"},\"enforcement\":{\"type\":\"string\",\"description\":\"The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise).\",\"enum\":[\"disabled\",\"active\",\"evaluate\"]},\"bypass_mode\":{\"type\":\"string\",\"description\":\"The permission level required to bypass this ruleset. \\\"repository\\\" allows those with bypass permission at the repository level to bypass. \\\"organization\\\" allows those with bypass permission at the organization level to bypass. \\\"none\\\" prevents anyone from bypassing.\",\"enum\":[\"none\",\"repository\",\"organization\"]},\"bypass_actors\":{\"type\":\"array\",\"description\":\"The actors that can bypass the rules in this ruleset\",\"items\":{\"title\":\"Repository Ruleset Bypass Actor\",\"type\":\"object\",\"description\":\"An actor that can bypass rules in a ruleset\",\"properties\":{\"actor_id\":{\"type\":\"integer\",\"description\":\"The ID of the actor that can bypass a ruleset\"},\"actor_type\":{\"type\":\"string\",\"enum\":[\"Team\",\"Integration\"],\"description\":\"The type of actor that can bypass a ruleset\"}}}},\"node_id\":{\"type\":\"string\"},\"_links\":{\"type\":\"object\",\"properties\":{\"self\":{\"type\":\"object\",\"properties\":{\"href\":{\"type\":\"string\",\"description\":\"The URL of the ruleset\"}}},\"html\":{\"type\":\"object\",\"properties\":{\"href\":{\"type\":\"string\",\"description\":\"The html URL of the ruleset\"}}}}},\"conditions\":{\"anyOf\":[{\"title\":\"Repository ruleset conditions for ref names\",\"type\":\"object\",\"description\":\"Parameters for a repository ruleset ref name condition\",\"properties\":{\"ref_name\":{\"type\":\"object\",\"properties\":{\"include\":{\"type\":\"array\",\"description\":\"Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.\",\"items\":{\"type\":\"string\"}},\"exclude\":{\"type\":\"array\",\"description\":\"Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.\",\"items\":{\"type\":\"string\"}}}}}},{\"title\":\"Organization ruleset conditions\",\"type\":\"object\",\"description\":\"Conditions for a organization ruleset\",\"allOf\":[{\"title\":\"Repository ruleset conditions for ref names\",\"type\":\"object\",\"description\":\"Parameters for a repository ruleset ref name condition\",\"properties\":{\"ref_name\":{\"type\":\"object\",\"properties\":{\"include\":{\"type\":\"array\",\"description\":\"Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.\",\"items\":{\"type\":\"string\"}},\"exclude\":{\"type\":\"array\",\"description\":\"Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.\",\"items\":{\"type\":\"string\"}}}}}},{\"title\":\"Repository ruleset conditions for repository names\",\"type\":\"object\",\"description\":\"Parameters for a repository name condition\",\"properties\":{\"repository_name\":{\"type\":\"object\",\"properties\":{\"include\":{\"type\":\"array\",\"description\":\"Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.\",\"items\":{\"type\":\"string\"}},\"exclude\":{\"type\":\"array\",\"description\":\"Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.\",\"items\":{\"type\":\"string\"}},\"protected\":{\"type\":\"boolean\",\"description\":\"Whether renaming of target repositories is prevented.\"}}}}}]}]},\"rules\":{\"type\":\"array\",\"items\":{\"title\":\"Repository Rule\",\"type\":\"object\",\"description\":\"A repository rule.\",\"oneOf\":[{\"title\":\"creation\",\"description\":\"Only allow users with bypass permission to create matching refs.\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"creation\"]}}},{\"title\":\"update\",\"description\":\"Only allow users with bypass permission to update matching refs.\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"update\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"update_allows_fetch_and_merge\":{\"type\":\"boolean\",\"description\":\"Branch can pull changes from its upstream repository\"}},\"required\":[\"update_allows_fetch_and_merge\"]}}},{\"title\":\"deletion\",\"description\":\"Only allow users with bypass permissions to delete matching refs.\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"deletion\"]}}},{\"title\":\"required_linear_history\",\"description\":\"Prevent merge commits from being pushed to matching branches.\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"required_linear_history\"]}}},{\"title\":\"required_deployments\",\"description\":\"Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule.\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"required_deployments\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"required_deployment_environments\":{\"type\":\"array\",\"description\":\"The environments that must be successfully deployed to before branches can be merged.\",\"items\":{\"type\":\"string\"}}},\"required\":[\"required_deployment_environments\"]}}},{\"title\":\"required_signatures\",\"description\":\"Commits pushed to matching branches must have verified signatures.\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"required_signatures\"]}}},{\"title\":\"pull_request\",\"description\":\"Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"pull_request\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"dismiss_stale_reviews_on_push\":{\"type\":\"boolean\",\"description\":\"New, reviewable commits pushed will dismiss previous pull request review approvals.\"},\"require_code_owner_review\":{\"type\":\"boolean\",\"description\":\"Require an approving review in pull requests that modify files that have a designated code owner.\"},\"require_last_push_approval\":{\"type\":\"boolean\",\"description\":\"Whether the most recent reviewable push must be approved by someone other than the person who pushed it.\"},\"required_approving_review_count\":{\"type\":\"integer\",\"description\":\"The number of approving reviews that are required before a pull request can be merged.\",\"minimum\":0,\"maximum\":10},\"required_review_thread_resolution\":{\"type\":\"boolean\",\"description\":\"All conversations on code must be resolved before a pull request can be merged.\"}},\"required\":[\"dismiss_stale_reviews_on_push\",\"require_code_owner_review\",\"require_last_push_approval\",\"required_approving_review_count\",\"required_review_thread_resolution\"]}}},{\"title\":\"required_status_checks\",\"description\":\"Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"required_status_checks\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"required_status_checks\":{\"type\":\"array\",\"description\":\"Status checks that are required.\",\"items\":{\"title\":\"StatusCheckConfiguration\",\"description\":\"Required status check\",\"type\":\"object\",\"properties\":{\"context\":{\"type\":\"string\",\"description\":\"The status check context name that must be present on the commit.\"},\"integration_id\":{\"type\":\"integer\",\"description\":\"The optional integration ID that this status check must originate from.\"}},\"required\":[\"context\"]}},\"strict_required_status_checks_policy\":{\"type\":\"boolean\",\"description\":\"Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled.\"}},\"required\":[\"required_status_checks\",\"strict_required_status_checks_policy\"]}}},{\"title\":\"non_fast_forward\",\"description\":\"Prevent users with push access from force pushing to branches.\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"non_fast_forward\"]}}},{\"title\":\"commit_message_pattern\",\"description\":\"Parameters to be used for the commit_message_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"commit_message_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}},{\"title\":\"commit_author_email_pattern\",\"description\":\"Parameters to be used for the commit_author_email_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"commit_author_email_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}},{\"title\":\"committer_email_pattern\",\"description\":\"Parameters to be used for the committer_email_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"committer_email_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}},{\"title\":\"branch_name_pattern\",\"description\":\"Parameters to be used for the branch_name_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"branch_name_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}},{\"title\":\"tag_name_pattern\",\"description\":\"Parameters to be used for the tag_name_pattern rule\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"tag_name_pattern\"]},\"parameters\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"How this rule will appear to users.\"},\"negate\":{\"type\":\"boolean\",\"description\":\"If true, the rule will fail if the pattern matches.\"},\"operator\":{\"type\":\"string\",\"description\":\"The operator to use for matching.\",\"enum\":[\"starts_with\",\"ends_with\",\"contains\",\"regex\"]},\"pattern\":{\"type\":\"string\",\"description\":\"The pattern to match with.\"}},\"required\":[\"operator\",\"pattern\"]}}}]}},\"created_at\":{\"type\":\"string\",\"format\":\"date-time\"},\"updated_at\":{\"type\":\"string\",\"format\":\"date-time\"}}}" }, { "code": 404, @@ -19796,7 +19887,7 @@ "responses": [ { "code": 201, - "schema": "{\"title\":\"GPG Key\",\"description\":\"A unique encryption key\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"integer\",\"example\":3},\"name\":{\"type\":\"string\",\"example\":\"Octocat's GPG Key\",\"nullable\":true},\"primary_key_id\":{\"type\":\"integer\",\"nullable\":true},\"key_id\":{\"type\":\"string\",\"example\":\"3262EFF25BA0D270\"},\"public_key\":{\"type\":\"string\",\"example\":\"xsBNBFayYZ...\"},\"emails\":{\"type\":\"array\",\"example\":[{\"email\":\"octocat@users.noreply.github.com\",\"verified\":true}],\"items\":{\"type\":\"object\",\"properties\":{\"email\":{\"type\":\"string\"},\"verified\":{\"type\":\"boolean\"}}}},\"subkeys\":{\"type\":\"array\",\"example\":[{\"id\":4,\"primary_key_id\":3,\"key_id\":\"4A595D4C72EE49C7\",\"public_key\":\"zsBNBFayYZ...\",\"emails\":[],\"subkeys\":[],\"can_sign\":false,\"can_encrypt_comms\":true,\"can_encrypt_storage\":true,\"can_certify\":false,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":null,\"revoked\":false}],\"items\":{\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"integer\"},\"primary_key_id\":{\"type\":\"integer\"},\"key_id\":{\"type\":\"string\"},\"public_key\":{\"type\":\"string\"},\"emails\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"email\":{\"type\":\"string\"},\"verified\":{\"type\":\"boolean\"}}}},\"subkeys\":{\"type\":\"array\",\"items\":{}},\"can_sign\":{\"type\":\"boolean\"},\"can_encrypt_comms\":{\"type\":\"boolean\"},\"can_encrypt_storage\":{\"type\":\"boolean\"},\"can_certify\":{\"type\":\"boolean\"},\"created_at\":{\"type\":\"string\"},\"expires_at\":{\"type\":\"string\",\"nullable\":true},\"raw_key\":{\"type\":\"string\",\"nullable\":true},\"revoked\":{\"type\":\"boolean\"}}}},\"can_sign\":{\"type\":\"boolean\",\"example\":true},\"can_encrypt_comms\":{\"type\":\"boolean\"},\"can_encrypt_storage\":{\"type\":\"boolean\"},\"can_certify\":{\"type\":\"boolean\",\"example\":true},\"created_at\":{\"type\":\"string\",\"format\":\"date-time\",\"example\":\"2016-03-24T11:31:04-06:00\"},\"expires_at\":{\"type\":\"string\",\"format\":\"date-time\",\"nullable\":true},\"revoked\":{\"type\":\"boolean\",\"example\":true},\"raw_key\":{\"type\":\"string\",\"nullable\":true}},\"required\":[\"id\",\"primary_key_id\",\"key_id\",\"raw_key\",\"public_key\",\"created_at\",\"expires_at\",\"can_sign\",\"can_encrypt_comms\",\"can_encrypt_storage\",\"can_certify\",\"emails\",\"subkeys\",\"revoked\"]}" + "schema": "{\"title\":\"GPG Key\",\"description\":\"A unique encryption key\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"integer\",\"example\":3},\"name\":{\"type\":\"string\",\"example\":\"Octocat's GPG Key\",\"nullable\":true},\"primary_key_id\":{\"type\":\"integer\",\"nullable\":true},\"key_id\":{\"type\":\"string\",\"example\":\"3262EFF25BA0D270\"},\"public_key\":{\"type\":\"string\",\"example\":\"xsBNBFayYZ...\"},\"emails\":{\"type\":\"array\",\"example\":[{\"email\":\"octocat@users.noreply.github.com\",\"verified\":true}],\"items\":{\"type\":\"object\",\"properties\":{\"email\":{\"type\":\"string\"},\"verified\":{\"type\":\"boolean\"}}}},\"subkeys\":{\"type\":\"array\",\"example\":[{\"id\":4,\"primary_key_id\":3,\"key_id\":\"4A595D4C72EE49C7\",\"public_key\":\"zsBNBFayYZ...\",\"emails\":[],\"can_sign\":false,\"can_encrypt_comms\":true,\"can_encrypt_storage\":true,\"can_certify\":false,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":null,\"revoked\":false}],\"items\":{\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"integer\"},\"primary_key_id\":{\"type\":\"integer\"},\"key_id\":{\"type\":\"string\"},\"public_key\":{\"type\":\"string\"},\"emails\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"email\":{\"type\":\"string\"},\"verified\":{\"type\":\"boolean\"}}}},\"subkeys\":{\"type\":\"array\",\"items\":{}},\"can_sign\":{\"type\":\"boolean\"},\"can_encrypt_comms\":{\"type\":\"boolean\"},\"can_encrypt_storage\":{\"type\":\"boolean\"},\"can_certify\":{\"type\":\"boolean\"},\"created_at\":{\"type\":\"string\"},\"expires_at\":{\"type\":\"string\",\"nullable\":true},\"raw_key\":{\"type\":\"string\",\"nullable\":true},\"revoked\":{\"type\":\"boolean\"}}}},\"can_sign\":{\"type\":\"boolean\",\"example\":true},\"can_encrypt_comms\":{\"type\":\"boolean\"},\"can_encrypt_storage\":{\"type\":\"boolean\"},\"can_certify\":{\"type\":\"boolean\",\"example\":true},\"created_at\":{\"type\":\"string\",\"format\":\"date-time\",\"example\":\"2016-03-24T11:31:04-06:00\"},\"expires_at\":{\"type\":\"string\",\"format\":\"date-time\",\"nullable\":true},\"revoked\":{\"type\":\"boolean\",\"example\":true},\"raw_key\":{\"type\":\"string\",\"nullable\":true}},\"required\":[\"id\",\"primary_key_id\",\"key_id\",\"raw_key\",\"public_key\",\"created_at\",\"expires_at\",\"can_sign\",\"can_encrypt_comms\",\"can_encrypt_storage\",\"can_certify\",\"emails\",\"subkeys\",\"revoked\"]}" }, { "code": 304, "schema": null }, { @@ -19827,7 +19918,7 @@ "responses": [ { "code": 201, - "schema": "{\"title\":\"GPG Key\",\"description\":\"A unique encryption key\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"integer\",\"example\":3},\"name\":{\"type\":\"string\",\"example\":\"Octocat's GPG Key\",\"nullable\":true},\"primary_key_id\":{\"type\":\"integer\",\"nullable\":true},\"key_id\":{\"type\":\"string\",\"example\":\"3262EFF25BA0D270\"},\"public_key\":{\"type\":\"string\",\"example\":\"xsBNBFayYZ...\"},\"emails\":{\"type\":\"array\",\"example\":[{\"email\":\"octocat@users.noreply.github.com\",\"verified\":true}],\"items\":{\"type\":\"object\",\"properties\":{\"email\":{\"type\":\"string\"},\"verified\":{\"type\":\"boolean\"}}}},\"subkeys\":{\"type\":\"array\",\"example\":[{\"id\":4,\"primary_key_id\":3,\"key_id\":\"4A595D4C72EE49C7\",\"public_key\":\"zsBNBFayYZ...\",\"emails\":[],\"subkeys\":[],\"can_sign\":false,\"can_encrypt_comms\":true,\"can_encrypt_storage\":true,\"can_certify\":false,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":null,\"revoked\":false}],\"items\":{\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"integer\"},\"primary_key_id\":{\"type\":\"integer\"},\"key_id\":{\"type\":\"string\"},\"public_key\":{\"type\":\"string\"},\"emails\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"email\":{\"type\":\"string\"},\"verified\":{\"type\":\"boolean\"}}}},\"subkeys\":{\"type\":\"array\",\"items\":{}},\"can_sign\":{\"type\":\"boolean\"},\"can_encrypt_comms\":{\"type\":\"boolean\"},\"can_encrypt_storage\":{\"type\":\"boolean\"},\"can_certify\":{\"type\":\"boolean\"},\"created_at\":{\"type\":\"string\"},\"expires_at\":{\"type\":\"string\",\"nullable\":true},\"raw_key\":{\"type\":\"string\",\"nullable\":true},\"revoked\":{\"type\":\"boolean\"}}}},\"can_sign\":{\"type\":\"boolean\",\"example\":true},\"can_encrypt_comms\":{\"type\":\"boolean\"},\"can_encrypt_storage\":{\"type\":\"boolean\"},\"can_certify\":{\"type\":\"boolean\",\"example\":true},\"created_at\":{\"type\":\"string\",\"format\":\"date-time\",\"example\":\"2016-03-24T11:31:04-06:00\"},\"expires_at\":{\"type\":\"string\",\"format\":\"date-time\",\"nullable\":true},\"revoked\":{\"type\":\"boolean\",\"example\":true},\"raw_key\":{\"type\":\"string\",\"nullable\":true}},\"required\":[\"id\",\"primary_key_id\",\"key_id\",\"raw_key\",\"public_key\",\"created_at\",\"expires_at\",\"can_sign\",\"can_encrypt_comms\",\"can_encrypt_storage\",\"can_certify\",\"emails\",\"subkeys\",\"revoked\"]}" + "schema": "{\"title\":\"GPG Key\",\"description\":\"A unique encryption key\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"integer\",\"example\":3},\"name\":{\"type\":\"string\",\"example\":\"Octocat's GPG Key\",\"nullable\":true},\"primary_key_id\":{\"type\":\"integer\",\"nullable\":true},\"key_id\":{\"type\":\"string\",\"example\":\"3262EFF25BA0D270\"},\"public_key\":{\"type\":\"string\",\"example\":\"xsBNBFayYZ...\"},\"emails\":{\"type\":\"array\",\"example\":[{\"email\":\"octocat@users.noreply.github.com\",\"verified\":true}],\"items\":{\"type\":\"object\",\"properties\":{\"email\":{\"type\":\"string\"},\"verified\":{\"type\":\"boolean\"}}}},\"subkeys\":{\"type\":\"array\",\"example\":[{\"id\":4,\"primary_key_id\":3,\"key_id\":\"4A595D4C72EE49C7\",\"public_key\":\"zsBNBFayYZ...\",\"emails\":[],\"can_sign\":false,\"can_encrypt_comms\":true,\"can_encrypt_storage\":true,\"can_certify\":false,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":null,\"revoked\":false}],\"items\":{\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"integer\"},\"primary_key_id\":{\"type\":\"integer\"},\"key_id\":{\"type\":\"string\"},\"public_key\":{\"type\":\"string\"},\"emails\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"email\":{\"type\":\"string\"},\"verified\":{\"type\":\"boolean\"}}}},\"subkeys\":{\"type\":\"array\",\"items\":{}},\"can_sign\":{\"type\":\"boolean\"},\"can_encrypt_comms\":{\"type\":\"boolean\"},\"can_encrypt_storage\":{\"type\":\"boolean\"},\"can_certify\":{\"type\":\"boolean\"},\"created_at\":{\"type\":\"string\"},\"expires_at\":{\"type\":\"string\",\"nullable\":true},\"raw_key\":{\"type\":\"string\",\"nullable\":true},\"revoked\":{\"type\":\"boolean\"}}}},\"can_sign\":{\"type\":\"boolean\",\"example\":true},\"can_encrypt_comms\":{\"type\":\"boolean\"},\"can_encrypt_storage\":{\"type\":\"boolean\"},\"can_certify\":{\"type\":\"boolean\",\"example\":true},\"created_at\":{\"type\":\"string\",\"format\":\"date-time\",\"example\":\"2016-03-24T11:31:04-06:00\"},\"expires_at\":{\"type\":\"string\",\"format\":\"date-time\",\"nullable\":true},\"revoked\":{\"type\":\"boolean\",\"example\":true},\"raw_key\":{\"type\":\"string\",\"nullable\":true}},\"required\":[\"id\",\"primary_key_id\",\"key_id\",\"raw_key\",\"public_key\",\"created_at\",\"expires_at\",\"can_sign\",\"can_encrypt_comms\",\"can_encrypt_storage\",\"can_certify\",\"emails\",\"subkeys\",\"revoked\"]}" }, { "code": 304, "schema": null }, { @@ -20254,7 +20345,7 @@ "responses": [ { "code": 200, - "schema": "{\"title\":\"GPG Key\",\"description\":\"A unique encryption key\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"integer\",\"example\":3},\"name\":{\"type\":\"string\",\"example\":\"Octocat's GPG Key\",\"nullable\":true},\"primary_key_id\":{\"type\":\"integer\",\"nullable\":true},\"key_id\":{\"type\":\"string\",\"example\":\"3262EFF25BA0D270\"},\"public_key\":{\"type\":\"string\",\"example\":\"xsBNBFayYZ...\"},\"emails\":{\"type\":\"array\",\"example\":[{\"email\":\"octocat@users.noreply.github.com\",\"verified\":true}],\"items\":{\"type\":\"object\",\"properties\":{\"email\":{\"type\":\"string\"},\"verified\":{\"type\":\"boolean\"}}}},\"subkeys\":{\"type\":\"array\",\"example\":[{\"id\":4,\"primary_key_id\":3,\"key_id\":\"4A595D4C72EE49C7\",\"public_key\":\"zsBNBFayYZ...\",\"emails\":[],\"subkeys\":[],\"can_sign\":false,\"can_encrypt_comms\":true,\"can_encrypt_storage\":true,\"can_certify\":false,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":null,\"revoked\":false}],\"items\":{\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"integer\"},\"primary_key_id\":{\"type\":\"integer\"},\"key_id\":{\"type\":\"string\"},\"public_key\":{\"type\":\"string\"},\"emails\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"email\":{\"type\":\"string\"},\"verified\":{\"type\":\"boolean\"}}}},\"subkeys\":{\"type\":\"array\",\"items\":{}},\"can_sign\":{\"type\":\"boolean\"},\"can_encrypt_comms\":{\"type\":\"boolean\"},\"can_encrypt_storage\":{\"type\":\"boolean\"},\"can_certify\":{\"type\":\"boolean\"},\"created_at\":{\"type\":\"string\"},\"expires_at\":{\"type\":\"string\",\"nullable\":true},\"raw_key\":{\"type\":\"string\",\"nullable\":true},\"revoked\":{\"type\":\"boolean\"}}}},\"can_sign\":{\"type\":\"boolean\",\"example\":true},\"can_encrypt_comms\":{\"type\":\"boolean\"},\"can_encrypt_storage\":{\"type\":\"boolean\"},\"can_certify\":{\"type\":\"boolean\",\"example\":true},\"created_at\":{\"type\":\"string\",\"format\":\"date-time\",\"example\":\"2016-03-24T11:31:04-06:00\"},\"expires_at\":{\"type\":\"string\",\"format\":\"date-time\",\"nullable\":true},\"revoked\":{\"type\":\"boolean\",\"example\":true},\"raw_key\":{\"type\":\"string\",\"nullable\":true}},\"required\":[\"id\",\"primary_key_id\",\"key_id\",\"raw_key\",\"public_key\",\"created_at\",\"expires_at\",\"can_sign\",\"can_encrypt_comms\",\"can_encrypt_storage\",\"can_certify\",\"emails\",\"subkeys\",\"revoked\"]}" + "schema": "{\"title\":\"GPG Key\",\"description\":\"A unique encryption key\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"integer\",\"example\":3},\"name\":{\"type\":\"string\",\"example\":\"Octocat's GPG Key\",\"nullable\":true},\"primary_key_id\":{\"type\":\"integer\",\"nullable\":true},\"key_id\":{\"type\":\"string\",\"example\":\"3262EFF25BA0D270\"},\"public_key\":{\"type\":\"string\",\"example\":\"xsBNBFayYZ...\"},\"emails\":{\"type\":\"array\",\"example\":[{\"email\":\"octocat@users.noreply.github.com\",\"verified\":true}],\"items\":{\"type\":\"object\",\"properties\":{\"email\":{\"type\":\"string\"},\"verified\":{\"type\":\"boolean\"}}}},\"subkeys\":{\"type\":\"array\",\"example\":[{\"id\":4,\"primary_key_id\":3,\"key_id\":\"4A595D4C72EE49C7\",\"public_key\":\"zsBNBFayYZ...\",\"emails\":[],\"can_sign\":false,\"can_encrypt_comms\":true,\"can_encrypt_storage\":true,\"can_certify\":false,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":null,\"revoked\":false}],\"items\":{\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"integer\"},\"primary_key_id\":{\"type\":\"integer\"},\"key_id\":{\"type\":\"string\"},\"public_key\":{\"type\":\"string\"},\"emails\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"email\":{\"type\":\"string\"},\"verified\":{\"type\":\"boolean\"}}}},\"subkeys\":{\"type\":\"array\",\"items\":{}},\"can_sign\":{\"type\":\"boolean\"},\"can_encrypt_comms\":{\"type\":\"boolean\"},\"can_encrypt_storage\":{\"type\":\"boolean\"},\"can_certify\":{\"type\":\"boolean\"},\"created_at\":{\"type\":\"string\"},\"expires_at\":{\"type\":\"string\",\"nullable\":true},\"raw_key\":{\"type\":\"string\",\"nullable\":true},\"revoked\":{\"type\":\"boolean\"}}}},\"can_sign\":{\"type\":\"boolean\",\"example\":true},\"can_encrypt_comms\":{\"type\":\"boolean\"},\"can_encrypt_storage\":{\"type\":\"boolean\"},\"can_certify\":{\"type\":\"boolean\",\"example\":true},\"created_at\":{\"type\":\"string\",\"format\":\"date-time\",\"example\":\"2016-03-24T11:31:04-06:00\"},\"expires_at\":{\"type\":\"string\",\"format\":\"date-time\",\"nullable\":true},\"revoked\":{\"type\":\"boolean\",\"example\":true},\"raw_key\":{\"type\":\"string\",\"nullable\":true}},\"required\":[\"id\",\"primary_key_id\",\"key_id\",\"raw_key\",\"public_key\",\"created_at\",\"expires_at\",\"can_sign\",\"can_encrypt_comms\",\"can_encrypt_storage\",\"can_certify\",\"emails\",\"subkeys\",\"revoked\"]}" }, { "code": 304, "schema": null }, { @@ -20281,7 +20372,7 @@ "responses": [ { "code": 200, - "schema": "{\"title\":\"GPG Key\",\"description\":\"A unique encryption key\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"integer\",\"example\":3},\"name\":{\"type\":\"string\",\"example\":\"Octocat's GPG Key\",\"nullable\":true},\"primary_key_id\":{\"type\":\"integer\",\"nullable\":true},\"key_id\":{\"type\":\"string\",\"example\":\"3262EFF25BA0D270\"},\"public_key\":{\"type\":\"string\",\"example\":\"xsBNBFayYZ...\"},\"emails\":{\"type\":\"array\",\"example\":[{\"email\":\"octocat@users.noreply.github.com\",\"verified\":true}],\"items\":{\"type\":\"object\",\"properties\":{\"email\":{\"type\":\"string\"},\"verified\":{\"type\":\"boolean\"}}}},\"subkeys\":{\"type\":\"array\",\"example\":[{\"id\":4,\"primary_key_id\":3,\"key_id\":\"4A595D4C72EE49C7\",\"public_key\":\"zsBNBFayYZ...\",\"emails\":[],\"subkeys\":[],\"can_sign\":false,\"can_encrypt_comms\":true,\"can_encrypt_storage\":true,\"can_certify\":false,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":null,\"revoked\":false}],\"items\":{\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"integer\"},\"primary_key_id\":{\"type\":\"integer\"},\"key_id\":{\"type\":\"string\"},\"public_key\":{\"type\":\"string\"},\"emails\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"email\":{\"type\":\"string\"},\"verified\":{\"type\":\"boolean\"}}}},\"subkeys\":{\"type\":\"array\",\"items\":{}},\"can_sign\":{\"type\":\"boolean\"},\"can_encrypt_comms\":{\"type\":\"boolean\"},\"can_encrypt_storage\":{\"type\":\"boolean\"},\"can_certify\":{\"type\":\"boolean\"},\"created_at\":{\"type\":\"string\"},\"expires_at\":{\"type\":\"string\",\"nullable\":true},\"raw_key\":{\"type\":\"string\",\"nullable\":true},\"revoked\":{\"type\":\"boolean\"}}}},\"can_sign\":{\"type\":\"boolean\",\"example\":true},\"can_encrypt_comms\":{\"type\":\"boolean\"},\"can_encrypt_storage\":{\"type\":\"boolean\"},\"can_certify\":{\"type\":\"boolean\",\"example\":true},\"created_at\":{\"type\":\"string\",\"format\":\"date-time\",\"example\":\"2016-03-24T11:31:04-06:00\"},\"expires_at\":{\"type\":\"string\",\"format\":\"date-time\",\"nullable\":true},\"revoked\":{\"type\":\"boolean\",\"example\":true},\"raw_key\":{\"type\":\"string\",\"nullable\":true}},\"required\":[\"id\",\"primary_key_id\",\"key_id\",\"raw_key\",\"public_key\",\"created_at\",\"expires_at\",\"can_sign\",\"can_encrypt_comms\",\"can_encrypt_storage\",\"can_certify\",\"emails\",\"subkeys\",\"revoked\"]}" + "schema": "{\"title\":\"GPG Key\",\"description\":\"A unique encryption key\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"integer\",\"example\":3},\"name\":{\"type\":\"string\",\"example\":\"Octocat's GPG Key\",\"nullable\":true},\"primary_key_id\":{\"type\":\"integer\",\"nullable\":true},\"key_id\":{\"type\":\"string\",\"example\":\"3262EFF25BA0D270\"},\"public_key\":{\"type\":\"string\",\"example\":\"xsBNBFayYZ...\"},\"emails\":{\"type\":\"array\",\"example\":[{\"email\":\"octocat@users.noreply.github.com\",\"verified\":true}],\"items\":{\"type\":\"object\",\"properties\":{\"email\":{\"type\":\"string\"},\"verified\":{\"type\":\"boolean\"}}}},\"subkeys\":{\"type\":\"array\",\"example\":[{\"id\":4,\"primary_key_id\":3,\"key_id\":\"4A595D4C72EE49C7\",\"public_key\":\"zsBNBFayYZ...\",\"emails\":[],\"can_sign\":false,\"can_encrypt_comms\":true,\"can_encrypt_storage\":true,\"can_certify\":false,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":null,\"revoked\":false}],\"items\":{\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"integer\"},\"primary_key_id\":{\"type\":\"integer\"},\"key_id\":{\"type\":\"string\"},\"public_key\":{\"type\":\"string\"},\"emails\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"email\":{\"type\":\"string\"},\"verified\":{\"type\":\"boolean\"}}}},\"subkeys\":{\"type\":\"array\",\"items\":{}},\"can_sign\":{\"type\":\"boolean\"},\"can_encrypt_comms\":{\"type\":\"boolean\"},\"can_encrypt_storage\":{\"type\":\"boolean\"},\"can_certify\":{\"type\":\"boolean\"},\"created_at\":{\"type\":\"string\"},\"expires_at\":{\"type\":\"string\",\"nullable\":true},\"raw_key\":{\"type\":\"string\",\"nullable\":true},\"revoked\":{\"type\":\"boolean\"}}}},\"can_sign\":{\"type\":\"boolean\",\"example\":true},\"can_encrypt_comms\":{\"type\":\"boolean\"},\"can_encrypt_storage\":{\"type\":\"boolean\"},\"can_certify\":{\"type\":\"boolean\",\"example\":true},\"created_at\":{\"type\":\"string\",\"format\":\"date-time\",\"example\":\"2016-03-24T11:31:04-06:00\"},\"expires_at\":{\"type\":\"string\",\"format\":\"date-time\",\"nullable\":true},\"revoked\":{\"type\":\"boolean\",\"example\":true},\"raw_key\":{\"type\":\"string\",\"nullable\":true}},\"required\":[\"id\",\"primary_key_id\",\"key_id\",\"raw_key\",\"public_key\",\"created_at\",\"expires_at\",\"can_sign\",\"can_encrypt_comms\",\"can_encrypt_storage\",\"can_certify\",\"emails\",\"subkeys\",\"revoked\"]}" }, { "code": 304, "schema": null }, { @@ -20617,7 +20708,7 @@ "responses": [ { "code": 200, - "schema": "{\"type\":\"array\",\"items\":{\"title\":\"GPG Key\",\"description\":\"A unique encryption key\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"integer\",\"example\":3},\"name\":{\"type\":\"string\",\"example\":\"Octocat's GPG Key\",\"nullable\":true},\"primary_key_id\":{\"type\":\"integer\",\"nullable\":true},\"key_id\":{\"type\":\"string\",\"example\":\"3262EFF25BA0D270\"},\"public_key\":{\"type\":\"string\",\"example\":\"xsBNBFayYZ...\"},\"emails\":{\"type\":\"array\",\"example\":[{\"email\":\"octocat@users.noreply.github.com\",\"verified\":true}],\"items\":{\"type\":\"object\",\"properties\":{\"email\":{\"type\":\"string\"},\"verified\":{\"type\":\"boolean\"}}}},\"subkeys\":{\"type\":\"array\",\"example\":[{\"id\":4,\"primary_key_id\":3,\"key_id\":\"4A595D4C72EE49C7\",\"public_key\":\"zsBNBFayYZ...\",\"emails\":[],\"subkeys\":[],\"can_sign\":false,\"can_encrypt_comms\":true,\"can_encrypt_storage\":true,\"can_certify\":false,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":null,\"revoked\":false}],\"items\":{\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"integer\"},\"primary_key_id\":{\"type\":\"integer\"},\"key_id\":{\"type\":\"string\"},\"public_key\":{\"type\":\"string\"},\"emails\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"email\":{\"type\":\"string\"},\"verified\":{\"type\":\"boolean\"}}}},\"subkeys\":{\"type\":\"array\",\"items\":{}},\"can_sign\":{\"type\":\"boolean\"},\"can_encrypt_comms\":{\"type\":\"boolean\"},\"can_encrypt_storage\":{\"type\":\"boolean\"},\"can_certify\":{\"type\":\"boolean\"},\"created_at\":{\"type\":\"string\"},\"expires_at\":{\"type\":\"string\",\"nullable\":true},\"raw_key\":{\"type\":\"string\",\"nullable\":true},\"revoked\":{\"type\":\"boolean\"}}}},\"can_sign\":{\"type\":\"boolean\",\"example\":true},\"can_encrypt_comms\":{\"type\":\"boolean\"},\"can_encrypt_storage\":{\"type\":\"boolean\"},\"can_certify\":{\"type\":\"boolean\",\"example\":true},\"created_at\":{\"type\":\"string\",\"format\":\"date-time\",\"example\":\"2016-03-24T11:31:04-06:00\"},\"expires_at\":{\"type\":\"string\",\"format\":\"date-time\",\"nullable\":true},\"revoked\":{\"type\":\"boolean\",\"example\":true},\"raw_key\":{\"type\":\"string\",\"nullable\":true}},\"required\":[\"id\",\"primary_key_id\",\"key_id\",\"raw_key\",\"public_key\",\"created_at\",\"expires_at\",\"can_sign\",\"can_encrypt_comms\",\"can_encrypt_storage\",\"can_certify\",\"emails\",\"subkeys\",\"revoked\"]}}" + "schema": "{\"type\":\"array\",\"items\":{\"title\":\"GPG Key\",\"description\":\"A unique encryption key\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"integer\",\"example\":3},\"name\":{\"type\":\"string\",\"example\":\"Octocat's GPG Key\",\"nullable\":true},\"primary_key_id\":{\"type\":\"integer\",\"nullable\":true},\"key_id\":{\"type\":\"string\",\"example\":\"3262EFF25BA0D270\"},\"public_key\":{\"type\":\"string\",\"example\":\"xsBNBFayYZ...\"},\"emails\":{\"type\":\"array\",\"example\":[{\"email\":\"octocat@users.noreply.github.com\",\"verified\":true}],\"items\":{\"type\":\"object\",\"properties\":{\"email\":{\"type\":\"string\"},\"verified\":{\"type\":\"boolean\"}}}},\"subkeys\":{\"type\":\"array\",\"example\":[{\"id\":4,\"primary_key_id\":3,\"key_id\":\"4A595D4C72EE49C7\",\"public_key\":\"zsBNBFayYZ...\",\"emails\":[],\"can_sign\":false,\"can_encrypt_comms\":true,\"can_encrypt_storage\":true,\"can_certify\":false,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":null,\"revoked\":false}],\"items\":{\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"integer\"},\"primary_key_id\":{\"type\":\"integer\"},\"key_id\":{\"type\":\"string\"},\"public_key\":{\"type\":\"string\"},\"emails\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"email\":{\"type\":\"string\"},\"verified\":{\"type\":\"boolean\"}}}},\"subkeys\":{\"type\":\"array\",\"items\":{}},\"can_sign\":{\"type\":\"boolean\"},\"can_encrypt_comms\":{\"type\":\"boolean\"},\"can_encrypt_storage\":{\"type\":\"boolean\"},\"can_certify\":{\"type\":\"boolean\"},\"created_at\":{\"type\":\"string\"},\"expires_at\":{\"type\":\"string\",\"nullable\":true},\"raw_key\":{\"type\":\"string\",\"nullable\":true},\"revoked\":{\"type\":\"boolean\"}}}},\"can_sign\":{\"type\":\"boolean\",\"example\":true},\"can_encrypt_comms\":{\"type\":\"boolean\"},\"can_encrypt_storage\":{\"type\":\"boolean\"},\"can_certify\":{\"type\":\"boolean\",\"example\":true},\"created_at\":{\"type\":\"string\",\"format\":\"date-time\",\"example\":\"2016-03-24T11:31:04-06:00\"},\"expires_at\":{\"type\":\"string\",\"format\":\"date-time\",\"nullable\":true},\"revoked\":{\"type\":\"boolean\",\"example\":true},\"raw_key\":{\"type\":\"string\",\"nullable\":true}},\"required\":[\"id\",\"primary_key_id\",\"key_id\",\"raw_key\",\"public_key\",\"created_at\",\"expires_at\",\"can_sign\",\"can_encrypt_comms\",\"can_encrypt_storage\",\"can_certify\",\"emails\",\"subkeys\",\"revoked\"]}}" }, { "code": 304, "schema": null }, { @@ -20644,7 +20735,7 @@ "responses": [ { "code": 200, - "schema": "{\"type\":\"array\",\"items\":{\"title\":\"GPG Key\",\"description\":\"A unique encryption key\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"integer\",\"example\":3},\"name\":{\"type\":\"string\",\"example\":\"Octocat's GPG Key\",\"nullable\":true},\"primary_key_id\":{\"type\":\"integer\",\"nullable\":true},\"key_id\":{\"type\":\"string\",\"example\":\"3262EFF25BA0D270\"},\"public_key\":{\"type\":\"string\",\"example\":\"xsBNBFayYZ...\"},\"emails\":{\"type\":\"array\",\"example\":[{\"email\":\"octocat@users.noreply.github.com\",\"verified\":true}],\"items\":{\"type\":\"object\",\"properties\":{\"email\":{\"type\":\"string\"},\"verified\":{\"type\":\"boolean\"}}}},\"subkeys\":{\"type\":\"array\",\"example\":[{\"id\":4,\"primary_key_id\":3,\"key_id\":\"4A595D4C72EE49C7\",\"public_key\":\"zsBNBFayYZ...\",\"emails\":[],\"subkeys\":[],\"can_sign\":false,\"can_encrypt_comms\":true,\"can_encrypt_storage\":true,\"can_certify\":false,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":null,\"revoked\":false}],\"items\":{\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"integer\"},\"primary_key_id\":{\"type\":\"integer\"},\"key_id\":{\"type\":\"string\"},\"public_key\":{\"type\":\"string\"},\"emails\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"email\":{\"type\":\"string\"},\"verified\":{\"type\":\"boolean\"}}}},\"subkeys\":{\"type\":\"array\",\"items\":{}},\"can_sign\":{\"type\":\"boolean\"},\"can_encrypt_comms\":{\"type\":\"boolean\"},\"can_encrypt_storage\":{\"type\":\"boolean\"},\"can_certify\":{\"type\":\"boolean\"},\"created_at\":{\"type\":\"string\"},\"expires_at\":{\"type\":\"string\",\"nullable\":true},\"raw_key\":{\"type\":\"string\",\"nullable\":true},\"revoked\":{\"type\":\"boolean\"}}}},\"can_sign\":{\"type\":\"boolean\",\"example\":true},\"can_encrypt_comms\":{\"type\":\"boolean\"},\"can_encrypt_storage\":{\"type\":\"boolean\"},\"can_certify\":{\"type\":\"boolean\",\"example\":true},\"created_at\":{\"type\":\"string\",\"format\":\"date-time\",\"example\":\"2016-03-24T11:31:04-06:00\"},\"expires_at\":{\"type\":\"string\",\"format\":\"date-time\",\"nullable\":true},\"revoked\":{\"type\":\"boolean\",\"example\":true},\"raw_key\":{\"type\":\"string\",\"nullable\":true}},\"required\":[\"id\",\"primary_key_id\",\"key_id\",\"raw_key\",\"public_key\",\"created_at\",\"expires_at\",\"can_sign\",\"can_encrypt_comms\",\"can_encrypt_storage\",\"can_certify\",\"emails\",\"subkeys\",\"revoked\"]}}" + "schema": "{\"type\":\"array\",\"items\":{\"title\":\"GPG Key\",\"description\":\"A unique encryption key\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"integer\",\"example\":3},\"name\":{\"type\":\"string\",\"example\":\"Octocat's GPG Key\",\"nullable\":true},\"primary_key_id\":{\"type\":\"integer\",\"nullable\":true},\"key_id\":{\"type\":\"string\",\"example\":\"3262EFF25BA0D270\"},\"public_key\":{\"type\":\"string\",\"example\":\"xsBNBFayYZ...\"},\"emails\":{\"type\":\"array\",\"example\":[{\"email\":\"octocat@users.noreply.github.com\",\"verified\":true}],\"items\":{\"type\":\"object\",\"properties\":{\"email\":{\"type\":\"string\"},\"verified\":{\"type\":\"boolean\"}}}},\"subkeys\":{\"type\":\"array\",\"example\":[{\"id\":4,\"primary_key_id\":3,\"key_id\":\"4A595D4C72EE49C7\",\"public_key\":\"zsBNBFayYZ...\",\"emails\":[],\"can_sign\":false,\"can_encrypt_comms\":true,\"can_encrypt_storage\":true,\"can_certify\":false,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":null,\"revoked\":false}],\"items\":{\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"integer\"},\"primary_key_id\":{\"type\":\"integer\"},\"key_id\":{\"type\":\"string\"},\"public_key\":{\"type\":\"string\"},\"emails\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"email\":{\"type\":\"string\"},\"verified\":{\"type\":\"boolean\"}}}},\"subkeys\":{\"type\":\"array\",\"items\":{}},\"can_sign\":{\"type\":\"boolean\"},\"can_encrypt_comms\":{\"type\":\"boolean\"},\"can_encrypt_storage\":{\"type\":\"boolean\"},\"can_certify\":{\"type\":\"boolean\"},\"created_at\":{\"type\":\"string\"},\"expires_at\":{\"type\":\"string\",\"nullable\":true},\"raw_key\":{\"type\":\"string\",\"nullable\":true},\"revoked\":{\"type\":\"boolean\"}}}},\"can_sign\":{\"type\":\"boolean\",\"example\":true},\"can_encrypt_comms\":{\"type\":\"boolean\"},\"can_encrypt_storage\":{\"type\":\"boolean\"},\"can_certify\":{\"type\":\"boolean\",\"example\":true},\"created_at\":{\"type\":\"string\",\"format\":\"date-time\",\"example\":\"2016-03-24T11:31:04-06:00\"},\"expires_at\":{\"type\":\"string\",\"format\":\"date-time\",\"nullable\":true},\"revoked\":{\"type\":\"boolean\",\"example\":true},\"raw_key\":{\"type\":\"string\",\"nullable\":true}},\"required\":[\"id\",\"primary_key_id\",\"key_id\",\"raw_key\",\"public_key\",\"created_at\",\"expires_at\",\"can_sign\",\"can_encrypt_comms\",\"can_encrypt_storage\",\"can_certify\",\"emails\",\"subkeys\",\"revoked\"]}}" }, { "code": 304, "schema": null }, { @@ -20671,7 +20762,7 @@ "responses": [ { "code": 200, - "schema": "{\"type\":\"array\",\"items\":{\"title\":\"GPG Key\",\"description\":\"A unique encryption key\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"integer\",\"example\":3},\"name\":{\"type\":\"string\",\"example\":\"Octocat's GPG Key\",\"nullable\":true},\"primary_key_id\":{\"type\":\"integer\",\"nullable\":true},\"key_id\":{\"type\":\"string\",\"example\":\"3262EFF25BA0D270\"},\"public_key\":{\"type\":\"string\",\"example\":\"xsBNBFayYZ...\"},\"emails\":{\"type\":\"array\",\"example\":[{\"email\":\"octocat@users.noreply.github.com\",\"verified\":true}],\"items\":{\"type\":\"object\",\"properties\":{\"email\":{\"type\":\"string\"},\"verified\":{\"type\":\"boolean\"}}}},\"subkeys\":{\"type\":\"array\",\"example\":[{\"id\":4,\"primary_key_id\":3,\"key_id\":\"4A595D4C72EE49C7\",\"public_key\":\"zsBNBFayYZ...\",\"emails\":[],\"subkeys\":[],\"can_sign\":false,\"can_encrypt_comms\":true,\"can_encrypt_storage\":true,\"can_certify\":false,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":null,\"revoked\":false}],\"items\":{\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"integer\"},\"primary_key_id\":{\"type\":\"integer\"},\"key_id\":{\"type\":\"string\"},\"public_key\":{\"type\":\"string\"},\"emails\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"email\":{\"type\":\"string\"},\"verified\":{\"type\":\"boolean\"}}}},\"subkeys\":{\"type\":\"array\",\"items\":{}},\"can_sign\":{\"type\":\"boolean\"},\"can_encrypt_comms\":{\"type\":\"boolean\"},\"can_encrypt_storage\":{\"type\":\"boolean\"},\"can_certify\":{\"type\":\"boolean\"},\"created_at\":{\"type\":\"string\"},\"expires_at\":{\"type\":\"string\",\"nullable\":true},\"raw_key\":{\"type\":\"string\",\"nullable\":true},\"revoked\":{\"type\":\"boolean\"}}}},\"can_sign\":{\"type\":\"boolean\",\"example\":true},\"can_encrypt_comms\":{\"type\":\"boolean\"},\"can_encrypt_storage\":{\"type\":\"boolean\"},\"can_certify\":{\"type\":\"boolean\",\"example\":true},\"created_at\":{\"type\":\"string\",\"format\":\"date-time\",\"example\":\"2016-03-24T11:31:04-06:00\"},\"expires_at\":{\"type\":\"string\",\"format\":\"date-time\",\"nullable\":true},\"revoked\":{\"type\":\"boolean\",\"example\":true},\"raw_key\":{\"type\":\"string\",\"nullable\":true}},\"required\":[\"id\",\"primary_key_id\",\"key_id\",\"raw_key\",\"public_key\",\"created_at\",\"expires_at\",\"can_sign\",\"can_encrypt_comms\",\"can_encrypt_storage\",\"can_certify\",\"emails\",\"subkeys\",\"revoked\"]}}" + "schema": "{\"type\":\"array\",\"items\":{\"title\":\"GPG Key\",\"description\":\"A unique encryption key\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"integer\",\"example\":3},\"name\":{\"type\":\"string\",\"example\":\"Octocat's GPG Key\",\"nullable\":true},\"primary_key_id\":{\"type\":\"integer\",\"nullable\":true},\"key_id\":{\"type\":\"string\",\"example\":\"3262EFF25BA0D270\"},\"public_key\":{\"type\":\"string\",\"example\":\"xsBNBFayYZ...\"},\"emails\":{\"type\":\"array\",\"example\":[{\"email\":\"octocat@users.noreply.github.com\",\"verified\":true}],\"items\":{\"type\":\"object\",\"properties\":{\"email\":{\"type\":\"string\"},\"verified\":{\"type\":\"boolean\"}}}},\"subkeys\":{\"type\":\"array\",\"example\":[{\"id\":4,\"primary_key_id\":3,\"key_id\":\"4A595D4C72EE49C7\",\"public_key\":\"zsBNBFayYZ...\",\"emails\":[],\"can_sign\":false,\"can_encrypt_comms\":true,\"can_encrypt_storage\":true,\"can_certify\":false,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":null,\"revoked\":false}],\"items\":{\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"integer\"},\"primary_key_id\":{\"type\":\"integer\"},\"key_id\":{\"type\":\"string\"},\"public_key\":{\"type\":\"string\"},\"emails\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"email\":{\"type\":\"string\"},\"verified\":{\"type\":\"boolean\"}}}},\"subkeys\":{\"type\":\"array\",\"items\":{}},\"can_sign\":{\"type\":\"boolean\"},\"can_encrypt_comms\":{\"type\":\"boolean\"},\"can_encrypt_storage\":{\"type\":\"boolean\"},\"can_certify\":{\"type\":\"boolean\"},\"created_at\":{\"type\":\"string\"},\"expires_at\":{\"type\":\"string\",\"nullable\":true},\"raw_key\":{\"type\":\"string\",\"nullable\":true},\"revoked\":{\"type\":\"boolean\"}}}},\"can_sign\":{\"type\":\"boolean\",\"example\":true},\"can_encrypt_comms\":{\"type\":\"boolean\"},\"can_encrypt_storage\":{\"type\":\"boolean\"},\"can_certify\":{\"type\":\"boolean\",\"example\":true},\"created_at\":{\"type\":\"string\",\"format\":\"date-time\",\"example\":\"2016-03-24T11:31:04-06:00\"},\"expires_at\":{\"type\":\"string\",\"format\":\"date-time\",\"nullable\":true},\"revoked\":{\"type\":\"boolean\",\"example\":true},\"raw_key\":{\"type\":\"string\",\"nullable\":true}},\"required\":[\"id\",\"primary_key_id\",\"key_id\",\"raw_key\",\"public_key\",\"created_at\",\"expires_at\",\"can_sign\",\"can_encrypt_comms\",\"can_encrypt_storage\",\"can_certify\",\"emails\",\"subkeys\",\"revoked\"]}}" } ], "parameters": [ diff --git a/scripts/update-endpoints/typescript.js b/scripts/update-endpoints/typescript.js index 95b74f89..73d35764 100644 --- a/scripts/update-endpoints/typescript.js +++ b/scripts/update-endpoints/typescript.js @@ -127,7 +127,7 @@ function endpointToKey(endpoint) { writeFileSync( "./src/generated/paginating-endpoints.ts", prettier.format( - `import { Endpoints } from "@octokit/types"; + `import type { Endpoints } from "@octokit/types"; export interface PaginatingEndpoints { ${sortEndpoints(endpoints).map(endpointToTypes).join("\n\n")} diff --git a/src/generated/paginating-endpoints.ts b/src/generated/paginating-endpoints.ts index dfec153c..411c1a79 100644 --- a/src/generated/paginating-endpoints.ts +++ b/src/generated/paginating-endpoints.ts @@ -1,4 +1,4 @@ -import { Endpoints } from "@octokit/types"; +import type { Endpoints } from "@octokit/types"; export interface PaginatingEndpoints { /** @@ -513,6 +513,14 @@ export interface PaginatingEndpoints { response: Endpoints["GET /orgs/{org}/repos"]["response"]; }; + /** + * @see https://docs.github.com/rest/repos/rules#get-organization-rulesets + */ + "GET /orgs/{org}/rulesets": { + parameters: Endpoints["GET /orgs/{org}/rulesets"]["parameters"]; + response: Endpoints["GET /orgs/{org}/rulesets"]["response"]; + }; + /** * @see https://docs.github.com/rest/reference/secret-scanning#list-secret-scanning-alerts-for-an-organization */ @@ -1277,6 +1285,22 @@ export interface PaginatingEndpoints { response: Endpoints["GET /repos/{owner}/{repo}/releases/{release_id}/reactions"]["response"]; }; + /** + * @see https://docs.github.com/rest/repos/rules#get-rules-for-a-branch + */ + "GET /repos/{owner}/{repo}/rules/branches/{branch}": { + parameters: Endpoints["GET /repos/{owner}/{repo}/rules/branches/{branch}"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/rules/branches/{branch}"]["response"]; + }; + + /** + * @see https://docs.github.com/rest/repos/rules#get-repository-rulesets + */ + "GET /repos/{owner}/{repo}/rulesets": { + parameters: Endpoints["GET /repos/{owner}/{repo}/rulesets"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/rulesets"]["response"]; + }; + /** * @see https://docs.github.com/rest/reference/secret-scanning#list-secret-scanning-alerts-for-a-repository */ @@ -1951,6 +1975,7 @@ export const paginatingEndpoints: (keyof PaginatingEndpoints)[] = [ "GET /orgs/{org}/projects", "GET /orgs/{org}/public_members", "GET /orgs/{org}/repos", + "GET /orgs/{org}/rulesets", "GET /orgs/{org}/secret-scanning/alerts", "GET /orgs/{org}/teams", "GET /orgs/{org}/teams/{team_slug}/discussions", @@ -2040,6 +2065,8 @@ export const paginatingEndpoints: (keyof PaginatingEndpoints)[] = [ "GET /repos/{owner}/{repo}/releases", "GET /repos/{owner}/{repo}/releases/{release_id}/assets", "GET /repos/{owner}/{repo}/releases/{release_id}/reactions", + "GET /repos/{owner}/{repo}/rules/branches/{branch}", + "GET /repos/{owner}/{repo}/rulesets", "GET /repos/{owner}/{repo}/secret-scanning/alerts", "GET /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations", "GET /repos/{owner}/{repo}/security-advisories",