jprdonnelly/docs
1
0
Fork 0
mirror of synced 2026-01-28 18:03:28 -05:00
Code Issues Projects Releases Wiki Activity

Merge branch 'main' into mchammer01/broken-links

Browse Source
This commit is contained in:
Shati Patel
2021-03-04 11:47:43 +00:00
committed by GitHub
parent 179f97b7e5 d4df9b2b6e
commit cac92ef3e9
12 changed files with 396 additions and 79 deletions
Download Patch File Download Diff File Expand all files Collapse all files

248
lib/rest/static/decorated/api.github.com.json
View File

@@ -3145,14 +3145,17 @@
"properties": {
"access_token": {
"type": "string",
"description": "<p>The OAuth access token used to authenticate to the GitHub API.</p>",
"description": "<p><strong>Required</strong>. The OAuth access token used to authenticate to the GitHub API.</p>",
"name": "access_token",
"in": "body",
"rawType": "string",
"rawDescription": "The OAuth access token used to authenticate to the GitHub API.",
"childParamsGroups": []
}
}
},
"required": [
"access_token"
]
},
"example": {
"access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a"
@@ -3189,7 +3192,7 @@
"bodyParameters": [
{
"type": "string",
"description": "<p>The OAuth access token used to authenticate to the GitHub API.</p>",
"description": "<p><strong>Required</strong>. The OAuth access token used to authenticate to the GitHub API.</p>",
"name": "access_token",
"in": "body",
"rawType": "string",
@@ -3244,7 +3247,7 @@
"properties": {
"access_token": {
"type": "string",
"description": "<p><strong>Required.</strong> The OAuth access token used to authenticate to the GitHub API.</p>",
"description": "<p><strong>Required</strong>. <strong>Required.</strong> The OAuth access token used to authenticate to the GitHub API.</p>",
"example": "e72e16c7e42f292c6912e7710c838347ae178b4a",
"name": "access_token",
"in": "body",
@@ -4104,7 +4107,10 @@
}
]
}
}
},
"required": [
"access_token"
]
}
}
}
@@ -4154,7 +4160,7 @@
"bodyParameters": [
{
"type": "string",
"description": "<p><strong>Required.</strong> The OAuth access token used to authenticate to the GitHub API.</p>",
"description": "<p><strong>Required</strong>. <strong>Required.</strong> The OAuth access token used to authenticate to the GitHub API.</p>",
"example": "e72e16c7e42f292c6912e7710c838347ae178b4a",
"name": "access_token",
"in": "body",
@@ -17116,6 +17122,7 @@
"encrypted_value": {
"type": "string",
"description": "<p>Value for your secret, encrypted with <a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a> using the public key retrieved from the <a href=\"https://docs.github.com/rest/reference/actions#get-an-organization-public-key\">Get an organization public key</a> endpoint.</p>",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$",
"name": "encrypted_value",
"in": "body",
"rawType": "string",
@@ -17160,7 +17167,7 @@
}
},
"example": {
"encrypted_value": "****************************************************************************************",
"encrypted_value": "c2VjcmV0",
"key_id": "012345678912345678",
"visibility": "selected",
"selected_repository_ids": [
@@ -17201,6 +17208,7 @@
{
"type": "string",
"description": "<p>Value for your secret, encrypted with <a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a> using the public key retrieved from the <a href=\"https://docs.github.com/rest/reference/actions#get-an-organization-public-key\">Get an organization public key</a> endpoint.</p>",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$",
"name": "encrypted_value",
"in": "body",
"rawType": "string",
@@ -34652,6 +34660,7 @@
"encrypted_value": {
"type": "string",
"description": "<p>Value for your secret, encrypted with <a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a> using the public key retrieved from the <a href=\"https://docs.github.com/rest/reference/actions#get-a-repository-public-key\">Get a repository public key</a> endpoint.</p>",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$",
"name": "encrypted_value",
"in": "body",
"rawType": "string",
@@ -34670,7 +34679,7 @@
}
},
"example": {
"encrypted_value": "****************************************************************************************",
"encrypted_value": "c2VjcmV0",
"key_id": "012345678912345678"
}
}
@@ -34706,6 +34715,7 @@
{
"type": "string",
"description": "<p>Value for your secret, encrypted with <a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a> using the public key retrieved from the <a href=\"https://docs.github.com/rest/reference/actions#get-a-repository-public-key\">Get a repository public key</a> endpoint.</p>",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$",
"name": "encrypted_value",
"in": "body",
"rawType": "string",
@@ -52441,6 +52451,7 @@
"application/json": {
"schema": {
"type": "object",
"nullable": true,
"properties": {
"wait_timer": {
"type": "integer",
@@ -52453,7 +52464,8 @@
"childParamsGroups": []
},
"reviewers": {
"type": "array of objects",
"type": "array of objects or null",
"nullable": true,
"description": "<p>The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.</p>",
"items": {
"type": "object",
@@ -52582,7 +52594,8 @@
}
]
}
}
},
"additionalProperties": false
}
}
}
@@ -52626,7 +52639,8 @@
"childParamsGroups": []
},
{
"type": "array of objects",
"type": "array of objects or null",
"nullable": true,
"description": "<p>The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.</p>",
"items": {
"type": "object",
@@ -75318,6 +75332,7 @@
"encrypted_value": {
"type": "string",
"description": "<p>Value for your secret, encrypted with <a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a> using the public key retrieved from the <a href=\"https://docs.github.com/rest/reference/actions#get-an-environment-public-key\">Get an environment public key</a> endpoint.</p>",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$",
"name": "encrypted_value",
"in": "body",
"rawType": "string",
@@ -75336,7 +75351,7 @@
}
},
"example": {
"encrypted_value": "****************************************************************************************",
"encrypted_value": "c2VjcmV0",
"key_id": "012345678912345678"
}
}
@@ -75372,6 +75387,7 @@
{
"type": "string",
"description": "<p>Value for your secret, encrypted with <a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a> using the public key retrieved from the <a href=\"https://docs.github.com/rest/reference/actions#get-an-environment-public-key\">Get an environment public key</a> endpoint.</p>",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$",
"name": "encrypted_value",
"in": "body",
"rawType": "string",
@@ -76098,13 +76114,13 @@
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/scim/v2/enterprises/ENTERPRISE/Groups/SCIM_GROUP_ID \\\n -d '{\"schemas\":[\"schemas\"],\"Operations\":[{}]}'",
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/scim/v2/enterprises/ENTERPRISE/Groups/SCIM_GROUP_ID \\\n -d '{\"schemas\":[\"schemas\"],\"Operations\":[{}]}'</code></pre>"
"source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/scim/v2/enterprises/ENTERPRISE/Groups/SCIM_GROUP_ID \\\n -d '{\"schemas\":[\"schemas\"],\"Operations\":[{\"op\":\"op\",\"path\":\"path\",\"value\":\"value\"}]}'",
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/scim/v2/enterprises/ENTERPRISE/Groups/SCIM_GROUP_ID \\\n -d '{\"schemas\":[\"schemas\"],\"Operations\":[{\"op\":\"op\",\"path\":\"path\",\"value\":\"value\"}]}'</code></pre>"
},
{
"lang": "JavaScript",
"source": "await octokit.request('PATCH /scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}', {\n enterprise: 'enterprise',\n scim_group_id: 'scim_group_id',\n schemas: [\n 'schemas'\n ],\n Operations: [\n {}\n ]\n})",
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'PATCH /scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}'</span>, {\n <span class=\"hljs-attr\">enterprise</span>: <span class=\"hljs-string\">'enterprise'</span>,\n <span class=\"hljs-attr\">scim_group_id</span>: <span class=\"hljs-string\">'scim_group_id'</span>,\n <span class=\"hljs-attr\">schemas</span>: [\n <span class=\"hljs-string\">'schemas'</span>\n ],\n <span class=\"hljs-attr\">Operations</span>: [\n {}\n ]\n})\n</code></pre>"
"source": "await octokit.request('PATCH /scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}', {\n enterprise: 'enterprise',\n scim_group_id: 'scim_group_id',\n schemas: [\n 'schemas'\n ],\n Operations: [\n {\n op: 'op',\n path: 'path',\n value: 'value'\n }\n ]\n})",
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'PATCH /scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}'</span>, {\n <span class=\"hljs-attr\">enterprise</span>: <span class=\"hljs-string\">'enterprise'</span>,\n <span class=\"hljs-attr\">scim_group_id</span>: <span class=\"hljs-string\">'scim_group_id'</span>,\n <span class=\"hljs-attr\">schemas</span>: [\n <span class=\"hljs-string\">'schemas'</span>\n ],\n <span class=\"hljs-attr\">Operations</span>: [\n {\n <span class=\"hljs-attr\">op</span>: <span class=\"hljs-string\">'op'</span>,\n <span class=\"hljs-attr\">path</span>: <span class=\"hljs-string\">'path'</span>,\n <span class=\"hljs-attr\">value</span>: <span class=\"hljs-string\">'value'</span>\n }\n ]\n})\n</code></pre>"
}
],
"summary": "Update an attribute for a SCIM enterprise group",
@@ -76138,14 +76154,110 @@
"Operations": {
"type": "array of objects",
"description": "<p><strong>Required</strong>. Array of <a href=\"https://tools.ietf.org/html/rfc7644#section-3.5.2\">SCIM operations</a>.</p>",
"minItems": 1,
"items": {
"type": "object"
"type": "object",
"properties": {
"op": {
"type": "string",
"enum": [
"add",
"Add",
"remove",
"Remove",
"replace",
"Replace"
],
"name": "op",
"in": "body",
"rawType": "string",
"description": "<p><strong>Required</strong>. undefined</p>",
"childParamsGroups": []
},
"path": {
"type": "string",
"name": "path",
"in": "body",
"rawType": "string",
"description": "<p>undefined</p>",
"childParamsGroups": []
},
"value": {
"oneOf": [
{
"type": "string"
},
{
"type": "object"
},
{
"type": "array"
}
],
"name": "value",
"in": "body",
"description": "<p>undefined</p>",
"childParamsGroups": []
}
},
"required": [
"op"
]
},
"name": "Operations",
"in": "body",
"rawType": "array",
"rawDescription": "Array of [SCIM operations](https://tools.ietf.org/html/rfc7644#section-3.5.2).",
"childParamsGroups": []
"childParamsGroups": [
{
"parentName": "Operations",
"parentType": "items",
"id": "operations-items",
"params": [
{
"type": "string",
"enum": [
"add",
"Add",
"remove",
"Remove",
"replace",
"Replace"
],
"name": "op",
"in": "body",
"rawType": "string",
"description": "<p><strong>Required</strong>. undefined</p>",
"childParamsGroups": []
},
{
"type": "string",
"name": "path",
"in": "body",
"rawType": "string",
"description": "<p>undefined</p>",
"childParamsGroups": []
},
{
"oneOf": [
{
"type": "string"
},
{
"type": "object"
},
{
"type": "array"
}
],
"name": "value",
"in": "body",
"description": "<p>undefined</p>",
"childParamsGroups": []
}
]
}
]
}
},
"required": [
@@ -76210,14 +76322,110 @@
{
"type": "array of objects",
"description": "<p><strong>Required</strong>. Array of <a href=\"https://tools.ietf.org/html/rfc7644#section-3.5.2\">SCIM operations</a>.</p>",
"minItems": 1,
"items": {
"type": "object"
"type": "object",
"properties": {
"op": {
"type": "string",
"enum": [
"add",
"Add",
"remove",
"Remove",
"replace",
"Replace"
],
"name": "op",
"in": "body",
"rawType": "string",
"description": "<p><strong>Required</strong>. undefined</p>",
"childParamsGroups": []
},
"path": {
"type": "string",
"name": "path",
"in": "body",
"rawType": "string",
"description": "<p>undefined</p>",
"childParamsGroups": []
},
"value": {
"oneOf": [
{
"type": "string"
},
{
"type": "object"
},
{
"type": "array"
}
],
"name": "value",
"in": "body",
"description": "<p>undefined</p>",
"childParamsGroups": []
}
},
"required": [
"op"
]
},
"name": "Operations",
"in": "body",
"rawType": "array",
"rawDescription": "Array of [SCIM operations](https://tools.ietf.org/html/rfc7644#section-3.5.2).",
"childParamsGroups": []
"childParamsGroups": [
{
"parentName": "Operations",
"parentType": "items",
"id": "operations-items",
"params": [
{
"type": "string",
"enum": [
"add",
"Add",
"remove",
"Remove",
"replace",
"Replace"
],
"name": "op",
"in": "body",
"rawType": "string",
"description": "<p><strong>Required</strong>. undefined</p>",
"childParamsGroups": []
},
{
"type": "string",
"name": "path",
"in": "body",
"rawType": "string",
"description": "<p>undefined</p>",
"childParamsGroups": []
},
{
"oneOf": [
{
"type": "string"
},
{
"type": "object"
},
{
"type": "array"
}
],
"name": "value",
"in": "body",
"description": "<p>undefined</p>",
"childParamsGroups": []
}
]
}
]
}
]
},

9
lib/rest/static/decorated/ghes-2.20.json
View File

@@ -6316,14 +6316,17 @@
"properties": {
"access_token": {
"type": "string",
"description": "<p>The OAuth access token used to authenticate to the GitHub API.</p>",
"description": "<p><strong>Required</strong>. The OAuth access token used to authenticate to the GitHub API.</p>",
"name": "access_token",
"in": "body",
"rawType": "string",
"rawDescription": "The OAuth access token used to authenticate to the GitHub API.",
"childParamsGroups": []
}
}
},
"required": [
"access_token"
]
},
"example": {
"access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a"
@@ -6360,7 +6363,7 @@
"bodyParameters": [
{
"type": "string",
"description": "<p>The OAuth access token used to authenticate to the GitHub API.</p>",
"description": "<p><strong>Required</strong>. The OAuth access token used to authenticate to the GitHub API.</p>",
"name": "access_token",
"in": "body",
"rawType": "string",

9
lib/rest/static/decorated/ghes-2.21.json
View File

@@ -6310,14 +6310,17 @@
"properties": {
"access_token": {
"type": "string",
"description": "<p>The OAuth access token used to authenticate to the GitHub API.</p>",
"description": "<p><strong>Required</strong>. The OAuth access token used to authenticate to the GitHub API.</p>",
"name": "access_token",
"in": "body",
"rawType": "string",
"rawDescription": "The OAuth access token used to authenticate to the GitHub API.",
"childParamsGroups": []
}
}
},
"required": [
"access_token"
]
},
"example": {
"access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a"
@@ -6354,7 +6357,7 @@
"bodyParameters": [
{
"type": "string",
"description": "<p>The OAuth access token used to authenticate to the GitHub API.</p>",
"description": "<p><strong>Required</strong>. The OAuth access token used to authenticate to the GitHub API.</p>",
"name": "access_token",
"in": "body",
"rawType": "string",

17
lib/rest/static/decorated/ghes-2.22.json
View File

@@ -6390,14 +6390,17 @@
"properties": {
"access_token": {
"type": "string",
"description": "<p>The OAuth access token used to authenticate to the GitHub API.</p>",
"description": "<p><strong>Required</strong>. The OAuth access token used to authenticate to the GitHub API.</p>",
"name": "access_token",
"in": "body",
"rawType": "string",
"rawDescription": "The OAuth access token used to authenticate to the GitHub API.",
"childParamsGroups": []
}
}
},
"required": [
"access_token"
]
},
"example": {
"access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a"
@@ -6434,7 +6437,7 @@
"bodyParameters": [
{
"type": "string",
"description": "<p>The OAuth access token used to authenticate to the GitHub API.</p>",
"description": "<p><strong>Required</strong>. The OAuth access token used to authenticate to the GitHub API.</p>",
"name": "access_token",
"in": "body",
"rawType": "string",
@@ -16259,6 +16262,7 @@
"encrypted_value": {
"type": "string",
"description": "<p>Value for your secret, encrypted with <a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a> using the public key retrieved from the <a href=\"https://docs.github.com/enterprise-server@2.22/rest/reference/actions#get-an-organization-public-key\">Get an organization public key</a> endpoint.</p>",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$",
"name": "encrypted_value",
"in": "body",
"rawType": "string",
@@ -16303,7 +16307,7 @@
}
},
"example": {
"encrypted_value": "****************************************************************************************",
"encrypted_value": "c2VjcmV0",
"key_id": "012345678912345678",
"visibility": "selected",
"selected_repository_ids": [
@@ -16344,6 +16348,7 @@
{
"type": "string",
"description": "<p>Value for your secret, encrypted with <a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a> using the public key retrieved from the <a href=\"https://docs.github.com/enterprise-server@2.22/rest/reference/actions#get-an-organization-public-key\">Get an organization public key</a> endpoint.</p>",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$",
"name": "encrypted_value",
"in": "body",
"rawType": "string",
@@ -29639,6 +29644,7 @@
"encrypted_value": {
"type": "string",
"description": "<p>Value for your secret, encrypted with <a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a> using the public key retrieved from the <a href=\"https://docs.github.com/enterprise-server@2.22/rest/reference/actions#get-a-repository-public-key\">Get a repository public key</a> endpoint.</p>",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$",
"name": "encrypted_value",
"in": "body",
"rawType": "string",
@@ -29657,7 +29663,7 @@
}
},
"example": {
"encrypted_value": "****************************************************************************************",
"encrypted_value": "c2VjcmV0",
"key_id": "012345678912345678"
}
}
@@ -29693,6 +29699,7 @@
{
"type": "string",
"description": "<p>Value for your secret, encrypted with <a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a> using the public key retrieved from the <a href=\"https://docs.github.com/enterprise-server@2.22/rest/reference/actions#get-a-repository-public-key\">Get a repository public key</a> endpoint.</p>",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$",
"name": "encrypted_value",
"in": "body",
"rawType": "string",

26
lib/rest/static/decorated/ghes-3.0.json
View File

@@ -6592,14 +6592,17 @@
"properties": {
"access_token": {
"type": "string",
"description": "<p>The OAuth access token used to authenticate to the GitHub API.</p>",
"description": "<p><strong>Required</strong>. The OAuth access token used to authenticate to the GitHub API.</p>",
"name": "access_token",
"in": "body",
"rawType": "string",
"rawDescription": "The OAuth access token used to authenticate to the GitHub API.",
"childParamsGroups": []
}
}
},
"required": [
"access_token"
]
},
"example": {
"access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a"
@@ -6636,7 +6639,7 @@
"bodyParameters": [
{
"type": "string",
"description": "<p>The OAuth access token used to authenticate to the GitHub API.</p>",
"description": "<p><strong>Required</strong>. The OAuth access token used to authenticate to the GitHub API.</p>",
"name": "access_token",
"in": "body",
"rawType": "string",
@@ -6691,7 +6694,7 @@
"properties": {
"access_token": {
"type": "string",
"description": "<p><strong>Required.</strong> The OAuth access token used to authenticate to the GitHub API.</p>",
"description": "<p><strong>Required</strong>. <strong>Required.</strong> The OAuth access token used to authenticate to the GitHub API.</p>",
"example": "e72e16c7e42f292c6912e7710c838347ae178b4a",
"name": "access_token",
"in": "body",
@@ -7551,7 +7554,10 @@
}
]
}
}
},
"required": [
"access_token"
]
}
}
}
@@ -7601,7 +7607,7 @@
"bodyParameters": [
{
"type": "string",
"description": "<p><strong>Required.</strong> The OAuth access token used to authenticate to the GitHub API.</p>",
"description": "<p><strong>Required</strong>. <strong>Required.</strong> The OAuth access token used to authenticate to the GitHub API.</p>",
"example": "e72e16c7e42f292c6912e7710c838347ae178b4a",
"name": "access_token",
"in": "body",
@@ -19946,6 +19952,7 @@
"encrypted_value": {
"type": "string",
"description": "<p>Value for your secret, encrypted with <a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a> using the public key retrieved from the <a href=\"https://docs.github.com/enterprise-server@3.0/rest/reference/actions#get-an-organization-public-key\">Get an organization public key</a> endpoint.</p>",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$",
"name": "encrypted_value",
"in": "body",
"rawType": "string",
@@ -19990,7 +19997,7 @@
}
},
"example": {
"encrypted_value": "****************************************************************************************",
"encrypted_value": "c2VjcmV0",
"key_id": "012345678912345678",
"visibility": "selected",
"selected_repository_ids": [
@@ -20031,6 +20038,7 @@
{
"type": "string",
"description": "<p>Value for your secret, encrypted with <a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a> using the public key retrieved from the <a href=\"https://docs.github.com/enterprise-server@3.0/rest/reference/actions#get-an-organization-public-key\">Get an organization public key</a> endpoint.</p>",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$",
"name": "encrypted_value",
"in": "body",
"rawType": "string",
@@ -33979,6 +33987,7 @@
"encrypted_value": {
"type": "string",
"description": "<p>Value for your secret, encrypted with <a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a> using the public key retrieved from the <a href=\"https://docs.github.com/enterprise-server@3.0/rest/reference/actions#get-a-repository-public-key\">Get a repository public key</a> endpoint.</p>",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$",
"name": "encrypted_value",
"in": "body",
"rawType": "string",
@@ -33997,7 +34006,7 @@
}
},
"example": {
"encrypted_value": "****************************************************************************************",
"encrypted_value": "c2VjcmV0",
"key_id": "012345678912345678"
}
}
@@ -34033,6 +34042,7 @@
{
"type": "string",
"description": "<p>Value for your secret, encrypted with <a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a> using the public key retrieved from the <a href=\"https://docs.github.com/enterprise-server@3.0/rest/reference/actions#get-a-repository-public-key\">Get a repository public key</a> endpoint.</p>",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$",
"name": "encrypted_value",
"in": "body",
"rawType": "string",

31
lib/rest/static/decorated/github.ae.json
View File

@@ -5203,14 +5203,17 @@
"properties": {
"access_token": {
"type": "string",
"description": "<p>The OAuth access token used to authenticate to the GitHub API.</p>",
"description": "<p><strong>Required</strong>. The OAuth access token used to authenticate to the GitHub API.</p>",
"name": "access_token",
"in": "body",
"rawType": "string",
"rawDescription": "The OAuth access token used to authenticate to the GitHub API.",
"childParamsGroups": []
}
}
},
"required": [
"access_token"
]
},
"example": {
"access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a"
@@ -5247,7 +5250,7 @@
"bodyParameters": [
{
"type": "string",
"description": "<p>The OAuth access token used to authenticate to the GitHub API.</p>",
"description": "<p><strong>Required</strong>. The OAuth access token used to authenticate to the GitHub API.</p>",
"name": "access_token",
"in": "body",
"rawType": "string",
@@ -14225,6 +14228,7 @@
"encrypted_value": {
"type": "string",
"description": "<p>Value for your secret, encrypted with <a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a> using the public key retrieved from the <a href=\"https://docs.github.com/github-ae@latest/rest/reference/actions#get-an-organization-public-key\">Get an organization public key</a> endpoint.</p>",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$",
"name": "encrypted_value",
"in": "body",
"rawType": "string",
@@ -14269,7 +14273,7 @@
}
},
"example": {
"encrypted_value": "****************************************************************************************",
"encrypted_value": "c2VjcmV0",
"key_id": "012345678912345678",
"visibility": "selected",
"selected_repository_ids": [
@@ -14310,6 +14314,7 @@
{
"type": "string",
"description": "<p>Value for your secret, encrypted with <a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a> using the public key retrieved from the <a href=\"https://docs.github.com/github-ae@latest/rest/reference/actions#get-an-organization-public-key\">Get an organization public key</a> endpoint.</p>",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$",
"name": "encrypted_value",
"in": "body",
"rawType": "string",
@@ -28035,6 +28040,7 @@
"encrypted_value": {
"type": "string",
"description": "<p>Value for your secret, encrypted with <a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a> using the public key retrieved from the <a href=\"https://docs.github.com/github-ae@latest/rest/reference/actions#get-a-repository-public-key\">Get a repository public key</a> endpoint.</p>",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$",
"name": "encrypted_value",
"in": "body",
"rawType": "string",
@@ -28053,7 +28059,7 @@
}
},
"example": {
"encrypted_value": "****************************************************************************************",
"encrypted_value": "c2VjcmV0",
"key_id": "012345678912345678"
}
}
@@ -28089,6 +28095,7 @@
{
"type": "string",
"description": "<p>Value for your secret, encrypted with <a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a> using the public key retrieved from the <a href=\"https://docs.github.com/github-ae@latest/rest/reference/actions#get-a-repository-public-key\">Get a repository public key</a> endpoint.</p>",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$",
"name": "encrypted_value",
"in": "body",
"rawType": "string",
@@ -45161,6 +45168,7 @@
"application/json": {
"schema": {
"type": "object",
"nullable": true,
"properties": {
"wait_timer": {
"type": "integer",
@@ -45173,7 +45181,8 @@
"childParamsGroups": []
},
"reviewers": {
"type": "array of objects",
"type": "array of objects or null",
"nullable": true,
"description": "<p>The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.</p>",
"items": {
"type": "object",
@@ -45302,7 +45311,8 @@
}
]
}
}
},
"additionalProperties": false
}
}
}
@@ -45346,7 +45356,8 @@
"childParamsGroups": []
},
{
"type": "array of objects",
"type": "array of objects or null",
"nullable": true,
"description": "<p>The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.</p>",
"items": {
"type": "object",
@@ -65981,6 +65992,7 @@
"encrypted_value": {
"type": "string",
"description": "<p>Value for your secret, encrypted with <a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a> using the public key retrieved from the <a href=\"https://docs.github.com/github-ae@latest/rest/reference/actions#get-an-environment-public-key\">Get an environment public key</a> endpoint.</p>",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$",
"name": "encrypted_value",
"in": "body",
"rawType": "string",
@@ -65999,7 +66011,7 @@
}
},
"example": {
"encrypted_value": "****************************************************************************************",
"encrypted_value": "c2VjcmV0",
"key_id": "012345678912345678"
}
}
@@ -66035,6 +66047,7 @@
{
"type": "string",
"description": "<p>Value for your secret, encrypted with <a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a> using the public key retrieved from the <a href=\"https://docs.github.com/github-ae@latest/rest/reference/actions#get-an-environment-public-key\">Get an environment public key</a> endpoint.</p>",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$",
"name": "encrypted_value",
"in": "body",
"rawType": "string",

65
lib/rest/static/dereferenced/api.github.com.deref.json
View File

@@ -6739,7 +6739,10 @@
"type": "string",
"description": "The OAuth access token used to authenticate to the GitHub API."
}
}
},
"required": [
"access_token"
]
},
"example": {
"access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a"
@@ -7146,7 +7149,10 @@
"single_file": "read"
}
}
}
},
"required": [
"access_token"
]
}
}
}
@@ -52790,7 +52796,8 @@
"properties": {
"encrypted_value": {
"type": "string",
"description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/reference/actions#get-an-organization-public-key) endpoint."
"description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/reference/actions#get-an-organization-public-key) endpoint.",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$"
},
"key_id": {
"type": "string",
@@ -52815,7 +52822,7 @@
}
},
"example": {
"encrypted_value": "****************************************************************************************",
"encrypted_value": "c2VjcmV0",
"key_id": "012345678912345678",
"visibility": "selected",
"selected_repository_ids": [
@@ -121715,7 +121722,8 @@
"properties": {
"encrypted_value": {
"type": "string",
"description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/reference/actions#get-a-repository-public-key) endpoint."
"description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/reference/actions#get-a-repository-public-key) endpoint.",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$"
},
"key_id": {
"type": "string",
@@ -121724,7 +121732,7 @@
}
},
"example": {
"encrypted_value": "****************************************************************************************",
"encrypted_value": "c2VjcmV0",
"key_id": "012345678912345678"
}
}
@@ -179976,6 +179984,7 @@
"application/json": {
"schema": {
"type": "object",
"nullable": true,
"properties": {
"wait_timer": {
"type": "integer",
@@ -179984,6 +179993,7 @@
},
"reviewers": {
"type": "array",
"nullable": true,
"description": "The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.",
"items": {
"type": "object",
@@ -180024,7 +180034,8 @@
"custom_branch_policies"
]
}
}
},
"additionalProperties": false
}
}
}
@@ -276869,7 +276880,8 @@
"properties": {
"encrypted_value": {
"type": "string",
"description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/rest/reference/actions#get-an-environment-public-key) endpoint."
"description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/rest/reference/actions#get-an-environment-public-key) endpoint.",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$"
},
"key_id": {
"type": "string",
@@ -276878,7 +276890,7 @@
}
},
"example": {
"encrypted_value": "****************************************************************************************",
"encrypted_value": "c2VjcmV0",
"key_id": "012345678912345678"
}
}
@@ -277734,8 +277746,41 @@
"Operations": {
"type": "array",
"description": "Array of [SCIM operations](https://tools.ietf.org/html/rfc7644#section-3.5.2).",
"minItems": 1,
"items": {
"type": "object"
"type": "object",
"properties": {
"op": {
"type": "string",
"enum": [
"add",
"Add",
"remove",
"Remove",
"replace",
"Replace"
]
},
"path": {
"type": "string"
},
"value": {
"oneOf": [
{
"type": "string"
},
{
"type": "object"
},
{
"type": "array"
}
]
}
},
"required": [
"op"
]
}
}
},

5
lib/rest/static/dereferenced/ghes-2.20.deref.json
View File

@@ -11412,7 +11412,10 @@
"type": "string",
"description": "The OAuth access token used to authenticate to the GitHub API."
}
}
},
"required": [
"access_token"
]
},
"example": {
"access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a"

5
lib/rest/static/dereferenced/ghes-2.21.deref.json
View File

@@ -11417,7 +11417,10 @@
"type": "string",
"description": "The OAuth access token used to authenticate to the GitHub API."
}
}
},
"required": [
"access_token"
]
},
"example": {
"access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a"

15
lib/rest/static/dereferenced/ghes-2.22.deref.json
View File

@@ -11510,7 +11510,10 @@
"type": "string",
"description": "The OAuth access token used to authenticate to the GitHub API."
}
}
},
"required": [
"access_token"
]
},
"example": {
"access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a"
@@ -51279,7 +51282,8 @@
"properties": {
"encrypted_value": {
"type": "string",
"description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/enterprise-server@2.22/rest/reference/actions#get-an-organization-public-key) endpoint."
"description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/enterprise-server@2.22/rest/reference/actions#get-an-organization-public-key) endpoint.",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$"
},
"key_id": {
"type": "string",
@@ -51304,7 +51308,7 @@
}
},
"example": {
"encrypted_value": "****************************************************************************************",
"encrypted_value": "c2VjcmV0",
"key_id": "012345678912345678",
"visibility": "selected",
"selected_repository_ids": [
@@ -105823,7 +105827,8 @@
"properties": {
"encrypted_value": {
"type": "string",
"description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/enterprise-server@2.22/rest/reference/actions#get-a-repository-public-key) endpoint."
"description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/enterprise-server@2.22/rest/reference/actions#get-a-repository-public-key) endpoint.",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$"
},
"key_id": {
"type": "string",
@@ -105832,7 +105837,7 @@
}
},
"example": {
"encrypted_value": "****************************************************************************************",
"encrypted_value": "c2VjcmV0",
"key_id": "012345678912345678"
}
}

20
lib/rest/static/dereferenced/ghes-3.0.deref.json
View File

@@ -11724,7 +11724,10 @@
"type": "string",
"description": "The OAuth access token used to authenticate to the GitHub API."
}
}
},
"required": [
"access_token"
]
},
"example": {
"access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a"
@@ -12131,7 +12134,10 @@
"single_file": "read"
}
}
}
},
"required": [
"access_token"
]
}
}
}
@@ -55559,7 +55565,8 @@
"properties": {
"encrypted_value": {
"type": "string",
"description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/enterprise-server@3.0/rest/reference/actions#get-an-organization-public-key) endpoint."
"description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/enterprise-server@3.0/rest/reference/actions#get-an-organization-public-key) endpoint.",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$"
},
"key_id": {
"type": "string",
@@ -55584,7 +55591,7 @@
}
},
"example": {
"encrypted_value": "****************************************************************************************",
"encrypted_value": "c2VjcmV0",
"key_id": "012345678912345678",
"visibility": "selected",
"selected_repository_ids": [
@@ -110822,7 +110829,8 @@
"properties": {
"encrypted_value": {
"type": "string",
"description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/enterprise-server@3.0/rest/reference/actions#get-a-repository-public-key) endpoint."
"description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/enterprise-server@3.0/rest/reference/actions#get-a-repository-public-key) endpoint.",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$"
},
"key_id": {
"type": "string",
@@ -110831,7 +110839,7 @@
}
},
"example": {
"encrypted_value": "****************************************************************************************",
"encrypted_value": "c2VjcmV0",
"key_id": "012345678912345678"
}
}

25
lib/rest/static/dereferenced/github.ae.deref.json
View File

@@ -9559,7 +9559,10 @@
"type": "string",
"description": "The OAuth access token used to authenticate to the GitHub API."
}
}
},
"required": [
"access_token"
]
},
"example": {
"access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a"
@@ -39222,7 +39225,8 @@
"properties": {
"encrypted_value": {
"type": "string",
"description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/github-ae@latest/rest/reference/actions#get-an-organization-public-key) endpoint."
"description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/github-ae@latest/rest/reference/actions#get-an-organization-public-key) endpoint.",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$"
},
"key_id": {
"type": "string",
@@ -39247,7 +39251,7 @@
}
},
"example": {
"encrypted_value": "****************************************************************************************",
"encrypted_value": "c2VjcmV0",
"key_id": "012345678912345678",
"visibility": "selected",
"selected_repository_ids": [
@@ -93158,7 +93162,8 @@
"properties": {
"encrypted_value": {
"type": "string",
"description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/github-ae@latest/rest/reference/actions#get-a-repository-public-key) endpoint."
"description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/github-ae@latest/rest/reference/actions#get-a-repository-public-key) endpoint.",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$"
},
"key_id": {
"type": "string",
@@ -93167,7 +93172,7 @@
}
},
"example": {
"encrypted_value": "****************************************************************************************",
"encrypted_value": "c2VjcmV0",
"key_id": "012345678912345678"
}
}
@@ -149045,6 +149050,7 @@
"application/json": {
"schema": {
"type": "object",
"nullable": true,
"properties": {
"wait_timer": {
"type": "integer",
@@ -149053,6 +149059,7 @@
},
"reviewers": {
"type": "array",
"nullable": true,
"description": "The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.",
"items": {
"type": "object",
@@ -149093,7 +149100,8 @@
"custom_branch_policies"
]
}
}
},
"additionalProperties": false
}
}
}
@@ -242273,7 +242281,8 @@
"properties": {
"encrypted_value": {
"type": "string",
"description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/github-ae@latest/rest/reference/actions#get-an-environment-public-key) endpoint."
"description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/github-ae@latest/rest/reference/actions#get-an-environment-public-key) endpoint.",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$"
},
"key_id": {
"type": "string",
@@ -242282,7 +242291,7 @@
}
},
"example": {
"encrypted_value": "****************************************************************************************",
"encrypted_value": "c2VjcmV0",
"key_id": "012345678912345678"
}
}