From fc4dec9975f18ee32b49bd3b5830d5378e6fc1d4 Mon Sep 17 00:00:00 2001 From: github-openapi-bot <69533958+github-openapi-bot@users.noreply.github.com> Date: Thu, 11 Feb 2021 12:37:13 -0500 Subject: [PATCH] Update OpenAPI Descriptions --- lib/rest/static/decorated/api.github.com.json | 66 ++++++++++++------- lib/rest/static/decorated/ghes-2.18.json | 51 +++++++++----- lib/rest/static/decorated/ghes-2.19.json | 51 +++++++++----- lib/rest/static/decorated/ghes-2.20.json | 66 ++++++++++++------- lib/rest/static/decorated/ghes-2.21.json | 66 ++++++++++++------- lib/rest/static/decorated/ghes-2.22.json | 66 ++++++++++++------- lib/rest/static/decorated/ghes-3.0.json | 66 ++++++++++++------- lib/rest/static/decorated/github.ae.json | 66 ++++++++++++------- .../dereferenced/api.github.com.deref.json | 39 +++++++---- .../static/dereferenced/ghes-2.18.deref.json | 36 +++++++--- .../static/dereferenced/ghes-2.19.deref.json | 36 +++++++--- .../static/dereferenced/ghes-2.20.deref.json | 39 +++++++---- .../static/dereferenced/ghes-2.21.deref.json | 39 +++++++---- .../static/dereferenced/ghes-2.22.deref.json | 39 +++++++---- .../static/dereferenced/ghes-3.0.deref.json | 39 +++++++---- .../static/dereferenced/github.ae.deref.json | 39 +++++++---- 16 files changed, 544 insertions(+), 260 deletions(-) diff --git a/lib/rest/static/decorated/api.github.com.json b/lib/rest/static/decorated/api.github.com.json index 311654903b..976c50d378 100644 --- a/lib/rest/static/decorated/api.github.com.json +++ b/lib/rest/static/decorated/api.github.com.json @@ -24167,7 +24167,7 @@ "properties": { "name": { "type": "string", - "description": "
Required. The name of the team.
", + "description": "The name of the team.
", "name": "name", "in": "body", "rawType": "string", @@ -24212,18 +24212,16 @@ "childParamsGroups": [] }, "parent_team_id": { - "type": "integer", + "type": "integer or null", "description": "The ID of a team to set as the parent team.
", + "nullable": true, "name": "parent_team_id", "in": "body", "rawType": "integer", "rawDescription": "The ID of a team to set as the parent team.", "childParamsGroups": [] } - }, - "required": [ - "name" - ] + } }, "example": { "name": "new team name", @@ -24248,7 +24246,7 @@ "bodyParameters": [ { "type": "string", - "description": "Required. The name of the team.
", + "description": "The name of the team.
", "name": "name", "in": "body", "rawType": "string", @@ -24293,8 +24291,9 @@ "childParamsGroups": [] }, { - "type": "integer", + "type": "integer or null", "description": "The ID of a team to set as the parent team.
", + "nullable": true, "name": "parent_team_id", "in": "body", "rawType": "integer", @@ -27036,7 +27035,8 @@ "rawDescription": "The permission to grant to the team for this project. Can be one of: \n\\* `read` - team members can read, but not write to or administer this project. \n\\* `write` - team members can read and write, but not administer this project. \n\\* `admin` - team members can read, write and administer this project. \nDefault: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs).\"", "childParamsGroups": [] } - } + }, + "nullable": true } } } @@ -58258,14 +58258,17 @@ } ], "description": "The title of the issue.
", + "nullable": true, "name": "title", "in": "body", "rawDescription": "The title of the issue.", + "type": "undefined or null", "childParamsGroups": [] }, "body": { - "type": "string", + "type": "string or null", "description": "The contents of the issue.
", + "nullable": true, "name": "body", "in": "body", "rawType": "string", @@ -58399,14 +58402,17 @@ } ], "description": "The title of the issue.
", + "nullable": true, "name": "title", "in": "body", "rawDescription": "The title of the issue.", + "type": "undefined or null", "childParamsGroups": [] }, { - "type": "string", + "type": "string or null", "description": "The contents of the issue.
", + "nullable": true, "name": "body", "in": "body", "rawType": "string", @@ -65670,13 +65676,13 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/comments \\\n -d '{\"body\":\"body\",\"path\":\"path\"}'", - "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/comments \\\n -d '{\"body\":\"body\",\"path\":\"path\"}'"
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/comments \\\n -d '{\"body\":\"body\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/comments \\\n -d '{\"body\":\"body\"}'"
},
{
"lang": "JavaScript",
- "source": "await octokit.request('POST /repos/{owner}/{repo}/pulls/{pull_number}/comments', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42,\n body: 'body',\n path: 'path'\n})",
- "html": "await octokit.request('POST /repos/{owner}/{repo}/pulls/{pull_number}/comments', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42,\n body: 'body',\n path: 'path'\n})\n"
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/pulls/{pull_number}/comments', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42,\n body: 'body'\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/pulls/{pull_number}/comments', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42,\n body: 'body'\n})\n"
}
],
"summary": "Create a review comment for a pull request",
@@ -65715,7 +65721,7 @@
},
"path": {
"type": "string",
- "description": "Required. The relative path to the file that necessitates a comment.
", + "description": "The relative path to the file that necessitates a comment.
", "name": "path", "in": "body", "rawType": "string", @@ -65787,8 +65793,7 @@ } }, "required": [ - "body", - "path" + "body" ] }, "examples": { @@ -65861,7 +65866,7 @@ }, { "type": "string", - "description": "Required. The relative path to the file that necessitates a comment.
", + "description": "The relative path to the file that necessitates a comment.
", "name": "path", "in": "body", "rawType": "string", @@ -66751,7 +66756,19 @@ "rawDescription": "An array of team `slug`s that will be requested.", "childParamsGroups": [] } - } + }, + "anyOf": [ + { + "required": [ + "reviewers" + ] + }, + { + "required": [ + "team_reviewers" + ] + } + ] }, "example": { "reviewers": [ @@ -66889,7 +66906,7 @@ "properties": { "reviewers": { "type": "array of strings", - "description": "An array of user logins that will be removed.
Required. An array of user logins that will be removed.
An array of user logins that will be removed.
Required. An array of user logins that will be removed.
The title of the issue.
", + "nullable": true, "name": "title", "in": "body", "rawDescription": "The title of the issue.", + "type": "undefined or null", "childParamsGroups": [] }, "body": { - "type": "string", + "type": "string or null", "description": "The contents of the issue.
", + "nullable": true, "name": "body", "in": "body", "rawType": "string", @@ -39713,14 +39716,17 @@ } ], "description": "The title of the issue.
", + "nullable": true, "name": "title", "in": "body", "rawDescription": "The title of the issue.", + "type": "undefined or null", "childParamsGroups": [] }, { - "type": "string", + "type": "string or null", "description": "The contents of the issue.
", + "nullable": true, "name": "body", "in": "body", "rawType": "string", @@ -47998,7 +48004,19 @@ "rawDescription": "An array of team `slug`s that will be requested.", "childParamsGroups": [] } - } + }, + "anyOf": [ + { + "required": [ + "reviewers" + ] + }, + { + "required": [ + "team_reviewers" + ] + } + ] }, "example": { "reviewers": [ @@ -48136,7 +48154,7 @@ "properties": { "reviewers": { "type": "array of strings", - "description": "An array of user logins that will be removed.
Required. An array of user logins that will be removed.
An array of user logins that will be removed.
Required. An array of user logins that will be removed.
Required. The name of the team.
", + "description": "The name of the team.
", "name": "name", "in": "body", "rawType": "string", @@ -55052,18 +55073,16 @@ "childParamsGroups": [] }, "parent_team_id": { - "type": "integer", + "type": "integer or null", "description": "The ID of a team to set as the parent team. Note: You must pass the hellcat-preview media type to use this parameter.
Required. The name of the team.
", + "description": "The name of the team.
", "name": "name", "in": "body", "rawType": "string", @@ -55140,8 +55159,9 @@ "childParamsGroups": [] }, { - "type": "integer", + "type": "integer or null", "description": "The ID of a team to set as the parent team. Note: You must pass the hellcat-preview media type to use this parameter.
The title of the issue.
", + "nullable": true, "name": "title", "in": "body", "rawDescription": "The title of the issue.", + "type": "undefined or null", "childParamsGroups": [] }, "body": { - "type": "string", + "type": "string or null", "description": "The contents of the issue.
", + "nullable": true, "name": "body", "in": "body", "rawType": "string", @@ -40378,14 +40381,17 @@ } ], "description": "The title of the issue.
", + "nullable": true, "name": "title", "in": "body", "rawDescription": "The title of the issue.", + "type": "undefined or null", "childParamsGroups": [] }, { - "type": "string", + "type": "string or null", "description": "The contents of the issue.
", + "nullable": true, "name": "body", "in": "body", "rawType": "string", @@ -48800,7 +48806,19 @@ "rawDescription": "An array of team `slug`s that will be requested.", "childParamsGroups": [] } - } + }, + "anyOf": [ + { + "required": [ + "reviewers" + ] + }, + { + "required": [ + "team_reviewers" + ] + } + ] }, "example": { "reviewers": [ @@ -48938,7 +48956,7 @@ "properties": { "reviewers": { "type": "array of strings", - "description": "An array of user logins that will be removed.
Required. An array of user logins that will be removed.
An array of user logins that will be removed.
Required. An array of user logins that will be removed.
Required. The name of the team.
", + "description": "The name of the team.
", "name": "name", "in": "body", "rawType": "string", @@ -55854,18 +55875,16 @@ "childParamsGroups": [] }, "parent_team_id": { - "type": "integer", + "type": "integer or null", "description": "The ID of a team to set as the parent team. Note: You must pass the hellcat-preview media type to use this parameter.
Required. The name of the team.
", + "description": "The name of the team.
", "name": "name", "in": "body", "rawType": "string", @@ -55942,8 +55961,9 @@ "childParamsGroups": [] }, { - "type": "integer", + "type": "integer or null", "description": "The ID of a team to set as the parent team. Note: You must pass the hellcat-preview media type to use this parameter.
The title of the issue.
", + "nullable": true, "name": "title", "in": "body", "rawDescription": "The title of the issue.", + "type": "undefined or null", "childParamsGroups": [] }, "body": { - "type": "string", + "type": "string or null", "description": "The contents of the issue.
", + "nullable": true, "name": "body", "in": "body", "rawType": "string", @@ -40849,14 +40852,17 @@ } ], "description": "The title of the issue.
", + "nullable": true, "name": "title", "in": "body", "rawDescription": "The title of the issue.", + "type": "undefined or null", "childParamsGroups": [] }, { - "type": "string", + "type": "string or null", "description": "The contents of the issue.
", + "nullable": true, "name": "body", "in": "body", "rawType": "string", @@ -48375,13 +48381,13 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/comments \\\n -d '{\"body\":\"body\",\"path\":\"path\"}'", - "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/comments \\\n -d '{\"body\":\"body\",\"path\":\"path\"}'"
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/comments \\\n -d '{\"body\":\"body\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/comments \\\n -d '{\"body\":\"body\"}'"
},
{
"lang": "JavaScript",
- "source": "await octokit.request('POST /repos/{owner}/{repo}/pulls/{pull_number}/comments', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42,\n body: 'body',\n path: 'path'\n})",
- "html": "await octokit.request('POST /repos/{owner}/{repo}/pulls/{pull_number}/comments', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42,\n body: 'body',\n path: 'path'\n})\n"
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/pulls/{pull_number}/comments', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42,\n body: 'body'\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/pulls/{pull_number}/comments', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42,\n body: 'body'\n})\n"
}
],
"summary": "Create a review comment for a pull request",
@@ -48420,7 +48426,7 @@
},
"path": {
"type": "string",
- "description": "Required. The relative path to the file that necessitates a comment.
", + "description": "The relative path to the file that necessitates a comment.
", "name": "path", "in": "body", "rawType": "string", @@ -48492,8 +48498,7 @@ } }, "required": [ - "body", - "path" + "body" ] }, "examples": { @@ -48566,7 +48571,7 @@ }, { "type": "string", - "description": "Required. The relative path to the file that necessitates a comment.
", + "description": "The relative path to the file that necessitates a comment.
", "name": "path", "in": "body", "rawType": "string", @@ -49454,7 +49459,19 @@ "rawDescription": "An array of team `slug`s that will be requested.", "childParamsGroups": [] } - } + }, + "anyOf": [ + { + "required": [ + "reviewers" + ] + }, + { + "required": [ + "team_reviewers" + ] + } + ] }, "example": { "reviewers": [ @@ -49592,7 +49609,7 @@ "properties": { "reviewers": { "type": "array of strings", - "description": "An array of user logins that will be removed.
Required. An array of user logins that will be removed.
An array of user logins that will be removed.
Required. An array of user logins that will be removed.
Required. The name of the team.
", + "description": "The name of the team.
", "name": "name", "in": "body", "rawType": "string", @@ -56500,18 +56520,16 @@ "childParamsGroups": [] }, "parent_team_id": { - "type": "integer", + "type": "integer or null", "description": "The ID of a team to set as the parent team.
", + "nullable": true, "name": "parent_team_id", "in": "body", "rawType": "integer", "rawDescription": "The ID of a team to set as the parent team.", "childParamsGroups": [] } - }, - "required": [ - "name" - ] + } }, "example": { "name": "new team name", @@ -56535,7 +56553,7 @@ "bodyParameters": [ { "type": "string", - "description": "Required. The name of the team.
", + "description": "The name of the team.
", "name": "name", "in": "body", "rawType": "string", @@ -56580,8 +56598,9 @@ "childParamsGroups": [] }, { - "type": "integer", + "type": "integer or null", "description": "The ID of a team to set as the parent team.
", + "nullable": true, "name": "parent_team_id", "in": "body", "rawType": "integer", @@ -59106,7 +59125,8 @@ "rawDescription": "The permission to grant to the team for this project. Can be one of: \n\\* `read` - team members can read, but not write to or administer this project. \n\\* `write` - team members can read and write, but not administer this project. \n\\* `admin` - team members can read, write and administer this project. \nDefault: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@2.20/rest/overview/resources-in-the-rest-api#http-verbs).\"", "childParamsGroups": [] } - } + }, + "nullable": true } } } diff --git a/lib/rest/static/decorated/ghes-2.21.json b/lib/rest/static/decorated/ghes-2.21.json index 2170f1e8b8..c8410b3442 100644 --- a/lib/rest/static/decorated/ghes-2.21.json +++ b/lib/rest/static/decorated/ghes-2.21.json @@ -16931,7 +16931,7 @@ "properties": { "name": { "type": "string", - "description": "Required. The name of the team.
", + "description": "The name of the team.
", "name": "name", "in": "body", "rawType": "string", @@ -16976,18 +16976,16 @@ "childParamsGroups": [] }, "parent_team_id": { - "type": "integer", + "type": "integer or null", "description": "The ID of a team to set as the parent team.
", + "nullable": true, "name": "parent_team_id", "in": "body", "rawType": "integer", "rawDescription": "The ID of a team to set as the parent team.", "childParamsGroups": [] } - }, - "required": [ - "name" - ] + } }, "example": { "name": "new team name", @@ -17012,7 +17010,7 @@ "bodyParameters": [ { "type": "string", - "description": "Required. The name of the team.
", + "description": "The name of the team.
", "name": "name", "in": "body", "rawType": "string", @@ -17057,8 +17055,9 @@ "childParamsGroups": [] }, { - "type": "integer", + "type": "integer or null", "description": "The ID of a team to set as the parent team.
", + "nullable": true, "name": "parent_team_id", "in": "body", "rawType": "integer", @@ -19709,7 +19708,8 @@ "rawDescription": "The permission to grant to the team for this project. Can be one of: \n\\* `read` - team members can read, but not write to or administer this project. \n\\* `write` - team members can read and write, but not administer this project. \n\\* `admin` - team members can read, write and administer this project. \nDefault: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@2.21/rest/overview/resources-in-the-rest-api#http-verbs).\"", "childParamsGroups": [] } - } + }, + "nullable": true } } } @@ -44582,14 +44582,17 @@ } ], "description": "The title of the issue.
", + "nullable": true, "name": "title", "in": "body", "rawDescription": "The title of the issue.", + "type": "undefined or null", "childParamsGroups": [] }, "body": { - "type": "string", + "type": "string or null", "description": "The contents of the issue.
", + "nullable": true, "name": "body", "in": "body", "rawType": "string", @@ -44723,14 +44726,17 @@ } ], "description": "The title of the issue.
", + "nullable": true, "name": "title", "in": "body", "rawDescription": "The title of the issue.", + "type": "undefined or null", "childParamsGroups": [] }, { - "type": "string", + "type": "string or null", "description": "The contents of the issue.
", + "nullable": true, "name": "body", "in": "body", "rawType": "string", @@ -52417,13 +52423,13 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/comments \\\n -d '{\"body\":\"body\",\"path\":\"path\"}'", - "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/comments \\\n -d '{\"body\":\"body\",\"path\":\"path\"}'"
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/comments \\\n -d '{\"body\":\"body\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/comments \\\n -d '{\"body\":\"body\"}'"
},
{
"lang": "JavaScript",
- "source": "await octokit.request('POST /repos/{owner}/{repo}/pulls/{pull_number}/comments', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42,\n body: 'body',\n path: 'path'\n})",
- "html": "await octokit.request('POST /repos/{owner}/{repo}/pulls/{pull_number}/comments', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42,\n body: 'body',\n path: 'path'\n})\n"
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/pulls/{pull_number}/comments', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42,\n body: 'body'\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/pulls/{pull_number}/comments', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42,\n body: 'body'\n})\n"
}
],
"summary": "Create a review comment for a pull request",
@@ -52462,7 +52468,7 @@
},
"path": {
"type": "string",
- "description": "Required. The relative path to the file that necessitates a comment.
", + "description": "The relative path to the file that necessitates a comment.
", "name": "path", "in": "body", "rawType": "string", @@ -52534,8 +52540,7 @@ } }, "required": [ - "body", - "path" + "body" ] }, "examples": { @@ -52608,7 +52613,7 @@ }, { "type": "string", - "description": "Required. The relative path to the file that necessitates a comment.
", + "description": "The relative path to the file that necessitates a comment.
", "name": "path", "in": "body", "rawType": "string", @@ -53498,7 +53503,19 @@ "rawDescription": "An array of team `slug`s that will be requested.", "childParamsGroups": [] } - } + }, + "anyOf": [ + { + "required": [ + "reviewers" + ] + }, + { + "required": [ + "team_reviewers" + ] + } + ] }, "example": { "reviewers": [ @@ -53636,7 +53653,7 @@ "properties": { "reviewers": { "type": "array of strings", - "description": "An array of user logins that will be removed.
Required. An array of user logins that will be removed.
An array of user logins that will be removed.
Required. An array of user logins that will be removed.
Required. The name of the team.
", + "description": "The name of the team.
", "name": "name", "in": "body", "rawType": "string", @@ -21179,18 +21179,16 @@ "childParamsGroups": [] }, "parent_team_id": { - "type": "integer", + "type": "integer or null", "description": "The ID of a team to set as the parent team.
", + "nullable": true, "name": "parent_team_id", "in": "body", "rawType": "integer", "rawDescription": "The ID of a team to set as the parent team.", "childParamsGroups": [] } - }, - "required": [ - "name" - ] + } }, "example": { "name": "new team name", @@ -21215,7 +21213,7 @@ "bodyParameters": [ { "type": "string", - "description": "Required. The name of the team.
", + "description": "The name of the team.
", "name": "name", "in": "body", "rawType": "string", @@ -21260,8 +21258,9 @@ "childParamsGroups": [] }, { - "type": "integer", + "type": "integer or null", "description": "The ID of a team to set as the parent team.
", + "nullable": true, "name": "parent_team_id", "in": "body", "rawType": "integer", @@ -23912,7 +23911,8 @@ "rawDescription": "The permission to grant to the team for this project. Can be one of: \n\\* `read` - team members can read, but not write to or administer this project. \n\\* `write` - team members can read and write, but not administer this project. \n\\* `admin` - team members can read, write and administer this project. \nDefault: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@2.22/rest/overview/resources-in-the-rest-api#http-verbs).\"", "childParamsGroups": [] } - } + }, + "nullable": true } } } @@ -52161,14 +52161,17 @@ } ], "description": "The title of the issue.
", + "nullable": true, "name": "title", "in": "body", "rawDescription": "The title of the issue.", + "type": "undefined or null", "childParamsGroups": [] }, "body": { - "type": "string", + "type": "string or null", "description": "The contents of the issue.
", + "nullable": true, "name": "body", "in": "body", "rawType": "string", @@ -52302,14 +52305,17 @@ } ], "description": "The title of the issue.
", + "nullable": true, "name": "title", "in": "body", "rawDescription": "The title of the issue.", + "type": "undefined or null", "childParamsGroups": [] }, { - "type": "string", + "type": "string or null", "description": "The contents of the issue.
", + "nullable": true, "name": "body", "in": "body", "rawType": "string", @@ -59961,13 +59967,13 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/comments \\\n -d '{\"body\":\"body\",\"path\":\"path\"}'", - "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/comments \\\n -d '{\"body\":\"body\",\"path\":\"path\"}'"
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/comments \\\n -d '{\"body\":\"body\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/comments \\\n -d '{\"body\":\"body\"}'"
},
{
"lang": "JavaScript",
- "source": "await octokit.request('POST /repos/{owner}/{repo}/pulls/{pull_number}/comments', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42,\n body: 'body',\n path: 'path'\n})",
- "html": "await octokit.request('POST /repos/{owner}/{repo}/pulls/{pull_number}/comments', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42,\n body: 'body',\n path: 'path'\n})\n"
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/pulls/{pull_number}/comments', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42,\n body: 'body'\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/pulls/{pull_number}/comments', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42,\n body: 'body'\n})\n"
}
],
"summary": "Create a review comment for a pull request",
@@ -60006,7 +60012,7 @@
},
"path": {
"type": "string",
- "description": "Required. The relative path to the file that necessitates a comment.
", + "description": "The relative path to the file that necessitates a comment.
", "name": "path", "in": "body", "rawType": "string", @@ -60078,8 +60084,7 @@ } }, "required": [ - "body", - "path" + "body" ] }, "examples": { @@ -60152,7 +60157,7 @@ }, { "type": "string", - "description": "Required. The relative path to the file that necessitates a comment.
", + "description": "The relative path to the file that necessitates a comment.
", "name": "path", "in": "body", "rawType": "string", @@ -61042,7 +61047,19 @@ "rawDescription": "An array of team `slug`s that will be requested.", "childParamsGroups": [] } - } + }, + "anyOf": [ + { + "required": [ + "reviewers" + ] + }, + { + "required": [ + "team_reviewers" + ] + } + ] }, "example": { "reviewers": [ @@ -61180,7 +61197,7 @@ "properties": { "reviewers": { "type": "array of strings", - "description": "An array of user logins that will be removed.
Required. An array of user logins that will be removed.
An array of user logins that will be removed.
Required. An array of user logins that will be removed.
Required. The name of the team.
", + "description": "The name of the team.
", "name": "name", "in": "body", "rawType": "string", @@ -25106,18 +25106,16 @@ "childParamsGroups": [] }, "parent_team_id": { - "type": "integer", + "type": "integer or null", "description": "The ID of a team to set as the parent team.
", + "nullable": true, "name": "parent_team_id", "in": "body", "rawType": "integer", "rawDescription": "The ID of a team to set as the parent team.", "childParamsGroups": [] } - }, - "required": [ - "name" - ] + } }, "example": { "name": "new team name", @@ -25142,7 +25140,7 @@ "bodyParameters": [ { "type": "string", - "description": "Required. The name of the team.
", + "description": "The name of the team.
", "name": "name", "in": "body", "rawType": "string", @@ -25187,8 +25185,9 @@ "childParamsGroups": [] }, { - "type": "integer", + "type": "integer or null", "description": "The ID of a team to set as the parent team.
", + "nullable": true, "name": "parent_team_id", "in": "body", "rawType": "integer", @@ -27839,7 +27838,8 @@ "rawDescription": "The permission to grant to the team for this project. Can be one of: \n\\* `read` - team members can read, but not write to or administer this project. \n\\* `write` - team members can read and write, but not administer this project. \n\\* `admin` - team members can read, write and administer this project. \nDefault: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@3.0/rest/overview/resources-in-the-rest-api#http-verbs).\"", "childParamsGroups": [] } - } + }, + "nullable": true } } } @@ -56854,14 +56854,17 @@ } ], "description": "The title of the issue.
", + "nullable": true, "name": "title", "in": "body", "rawDescription": "The title of the issue.", + "type": "undefined or null", "childParamsGroups": [] }, "body": { - "type": "string", + "type": "string or null", "description": "The contents of the issue.
", + "nullable": true, "name": "body", "in": "body", "rawType": "string", @@ -56995,14 +56998,17 @@ } ], "description": "The title of the issue.
", + "nullable": true, "name": "title", "in": "body", "rawDescription": "The title of the issue.", + "type": "undefined or null", "childParamsGroups": [] }, { - "type": "string", + "type": "string or null", "description": "The contents of the issue.
", + "nullable": true, "name": "body", "in": "body", "rawType": "string", @@ -64654,13 +64660,13 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/comments \\\n -d '{\"body\":\"body\",\"path\":\"path\"}'", - "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/comments \\\n -d '{\"body\":\"body\",\"path\":\"path\"}'"
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/comments \\\n -d '{\"body\":\"body\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/comments \\\n -d '{\"body\":\"body\"}'"
},
{
"lang": "JavaScript",
- "source": "await octokit.request('POST /repos/{owner}/{repo}/pulls/{pull_number}/comments', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42,\n body: 'body',\n path: 'path'\n})",
- "html": "await octokit.request('POST /repos/{owner}/{repo}/pulls/{pull_number}/comments', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42,\n body: 'body',\n path: 'path'\n})\n"
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/pulls/{pull_number}/comments', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42,\n body: 'body'\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/pulls/{pull_number}/comments', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42,\n body: 'body'\n})\n"
}
],
"summary": "Create a review comment for a pull request",
@@ -64699,7 +64705,7 @@
},
"path": {
"type": "string",
- "description": "Required. The relative path to the file that necessitates a comment.
", + "description": "The relative path to the file that necessitates a comment.
", "name": "path", "in": "body", "rawType": "string", @@ -64771,8 +64777,7 @@ } }, "required": [ - "body", - "path" + "body" ] }, "examples": { @@ -64845,7 +64850,7 @@ }, { "type": "string", - "description": "Required. The relative path to the file that necessitates a comment.
", + "description": "The relative path to the file that necessitates a comment.
", "name": "path", "in": "body", "rawType": "string", @@ -65735,7 +65740,19 @@ "rawDescription": "An array of team `slug`s that will be requested.", "childParamsGroups": [] } - } + }, + "anyOf": [ + { + "required": [ + "reviewers" + ] + }, + { + "required": [ + "team_reviewers" + ] + } + ] }, "example": { "reviewers": [ @@ -65873,7 +65890,7 @@ "properties": { "reviewers": { "type": "array of strings", - "description": "An array of user logins that will be removed.
Required. An array of user logins that will be removed.
An array of user logins that will be removed.
Required. An array of user logins that will be removed.
Required. The name of the team.
", + "description": "The name of the team.
", "name": "name", "in": "body", "rawType": "string", @@ -15121,18 +15121,16 @@ "childParamsGroups": [] }, "parent_team_id": { - "type": "integer", + "type": "integer or null", "description": "The ID of a team to set as the parent team.
", + "nullable": true, "name": "parent_team_id", "in": "body", "rawType": "integer", "rawDescription": "The ID of a team to set as the parent team.", "childParamsGroups": [] } - }, - "required": [ - "name" - ] + } }, "example": { "name": "new team name", @@ -15157,7 +15155,7 @@ "bodyParameters": [ { "type": "string", - "description": "Required. The name of the team.
", + "description": "The name of the team.
", "name": "name", "in": "body", "rawType": "string", @@ -15202,8 +15200,9 @@ "childParamsGroups": [] }, { - "type": "integer", + "type": "integer or null", "description": "The ID of a team to set as the parent team.
", + "nullable": true, "name": "parent_team_id", "in": "body", "rawType": "integer", @@ -17854,7 +17853,8 @@ "rawDescription": "The permission to grant to the team for this project. Can be one of: \n\\* `read` - team members can read, but not write to or administer this project. \n\\* `write` - team members can read and write, but not administer this project. \n\\* `admin` - team members can read, write and administer this project. \nDefault: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#http-verbs).\"", "childParamsGroups": [] } - } + }, + "nullable": true } } } @@ -42730,14 +42730,17 @@ } ], "description": "The title of the issue.
", + "nullable": true, "name": "title", "in": "body", "rawDescription": "The title of the issue.", + "type": "undefined or null", "childParamsGroups": [] }, "body": { - "type": "string", + "type": "string or null", "description": "The contents of the issue.
", + "nullable": true, "name": "body", "in": "body", "rawType": "string", @@ -42871,14 +42874,17 @@ } ], "description": "The title of the issue.
", + "nullable": true, "name": "title", "in": "body", "rawDescription": "The title of the issue.", + "type": "undefined or null", "childParamsGroups": [] }, { - "type": "string", + "type": "string or null", "description": "The contents of the issue.
", + "nullable": true, "name": "body", "in": "body", "rawType": "string", @@ -50142,13 +50148,13 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/comments \\\n -d '{\"body\":\"body\",\"path\":\"path\"}'", - "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/comments \\\n -d '{\"body\":\"body\",\"path\":\"path\"}'"
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/comments \\\n -d '{\"body\":\"body\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/comments \\\n -d '{\"body\":\"body\"}'"
},
{
"lang": "JavaScript",
- "source": "await octokit.request('POST /repos/{owner}/{repo}/pulls/{pull_number}/comments', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42,\n body: 'body',\n path: 'path'\n})",
- "html": "await octokit.request('POST /repos/{owner}/{repo}/pulls/{pull_number}/comments', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42,\n body: 'body',\n path: 'path'\n})\n"
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/pulls/{pull_number}/comments', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42,\n body: 'body'\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/pulls/{pull_number}/comments', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42,\n body: 'body'\n})\n"
}
],
"summary": "Create a review comment for a pull request",
@@ -50187,7 +50193,7 @@
},
"path": {
"type": "string",
- "description": "Required. The relative path to the file that necessitates a comment.
", + "description": "The relative path to the file that necessitates a comment.
", "name": "path", "in": "body", "rawType": "string", @@ -50259,8 +50265,7 @@ } }, "required": [ - "body", - "path" + "body" ] }, "examples": { @@ -50333,7 +50338,7 @@ }, { "type": "string", - "description": "Required. The relative path to the file that necessitates a comment.
", + "description": "The relative path to the file that necessitates a comment.
", "name": "path", "in": "body", "rawType": "string", @@ -51223,7 +51228,19 @@ "rawDescription": "An array of team `slug`s that will be requested.", "childParamsGroups": [] } - } + }, + "anyOf": [ + { + "required": [ + "reviewers" + ] + }, + { + "required": [ + "team_reviewers" + ] + } + ] }, "example": { "reviewers": [ @@ -51361,7 +51378,7 @@ "properties": { "reviewers": { "type": "array of strings", - "description": "An array of user logins that will be removed.
Required. An array of user logins that will be removed.
An array of user logins that will be removed.
Required. An array of user logins that will be removed.