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.

", + "description": "

Required. An array of user logins that will be removed.

", "items": { "type": "string" }, @@ -66911,7 +66928,10 @@ "rawDescription": "An array of team `slug`s that will be removed.", "childParamsGroups": [] } - } + }, + "required": [ + "reviewers" + ] }, "example": { "reviewers": [ @@ -66955,7 +66975,7 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

An array of user logins that will be removed.

", + "description": "

Required. An array of user logins that will be removed.

", "items": { "type": "string" }, diff --git a/lib/rest/static/decorated/ghes-2.18.json b/lib/rest/static/decorated/ghes-2.18.json index 6095c04a75..cd86bd7021 100644 --- a/lib/rest/static/decorated/ghes-2.18.json +++ b/lib/rest/static/decorated/ghes-2.18.json @@ -39572,14 +39572,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", @@ -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.

", + "description": "

Required. An array of user logins that will be removed.

", "items": { "type": "string" }, @@ -48158,7 +48176,10 @@ "rawDescription": "An array of team `slug`s that will be removed.", "childParamsGroups": [] } - } + }, + "required": [ + "reviewers" + ] }, "example": { "reviewers": [ @@ -48202,7 +48223,7 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

An array of user logins that will be removed.

", + "description": "

Required. An array of user logins that will be removed.

", "items": { "type": "string" }, @@ -55007,7 +55028,7 @@ "properties": { "name": { "type": "string", - "description": "

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.

", + "nullable": true, "name": "parent_team_id", "in": "body", "rawType": "integer", "rawDescription": "The ID of a team to set as the parent team. **Note**: You must pass the `hellcat-preview` media type to use this parameter.", "childParamsGroups": [] } - }, - "required": [ - "name" - ] + } }, "example": { "name": "new team name", @@ -55095,7 +55114,7 @@ "bodyParameters": [ { "type": "string", - "description": "

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.

", + "nullable": true, "name": "parent_team_id", "in": "body", "rawType": "integer", @@ -57916,7 +57936,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.18/rest/overview/resources-in-the-rest-api#http-verbs).\" \n**Note**: If you pass the `hellcat-preview` media type, you can promote—but not demote—a `permission` attribute inherited from a parent team.", "childParamsGroups": [] } - } + }, + "nullable": true } } } diff --git a/lib/rest/static/decorated/ghes-2.19.json b/lib/rest/static/decorated/ghes-2.19.json index 79a5e09ac6..8a2d037698 100644 --- a/lib/rest/static/decorated/ghes-2.19.json +++ b/lib/rest/static/decorated/ghes-2.19.json @@ -40237,14 +40237,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", @@ -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.

", + "description": "

Required. An array of user logins that will be removed.

", "items": { "type": "string" }, @@ -48960,7 +48978,10 @@ "rawDescription": "An array of team `slug`s that will be removed.", "childParamsGroups": [] } - } + }, + "required": [ + "reviewers" + ] }, "example": { "reviewers": [ @@ -49004,7 +49025,7 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

An array of user logins that will be removed.

", + "description": "

Required. An array of user logins that will be removed.

", "items": { "type": "string" }, @@ -55809,7 +55830,7 @@ "properties": { "name": { "type": "string", - "description": "

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.

", + "nullable": true, "name": "parent_team_id", "in": "body", "rawType": "integer", "rawDescription": "The ID of a team to set as the parent team. **Note**: You must pass the `hellcat-preview` media type to use this parameter.", "childParamsGroups": [] } - }, - "required": [ - "name" - ] + } }, "example": { "name": "new team name", @@ -55897,7 +55916,7 @@ "bodyParameters": [ { "type": "string", - "description": "

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.

", + "nullable": true, "name": "parent_team_id", "in": "body", "rawType": "integer", @@ -58506,7 +58526,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.19/rest/overview/resources-in-the-rest-api#http-verbs).\" \n**Note**: If you pass the `hellcat-preview` media type, you can promote—but not demote—a `permission` attribute inherited from a parent team.", "childParamsGroups": [] } - } + }, + "nullable": true } } } diff --git a/lib/rest/static/decorated/ghes-2.20.json b/lib/rest/static/decorated/ghes-2.20.json index 8058940663..d87a2037e4 100644 --- a/lib/rest/static/decorated/ghes-2.20.json +++ b/lib/rest/static/decorated/ghes-2.20.json @@ -40708,14 +40708,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", @@ -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.

", + "description": "

Required. An array of user logins that will be removed.

", "items": { "type": "string" }, @@ -49614,7 +49631,10 @@ "rawDescription": "An array of team `slug`s that will be removed.", "childParamsGroups": [] } - } + }, + "required": [ + "reviewers" + ] }, "example": { "reviewers": [ @@ -49658,7 +49678,7 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

An array of user logins that will be removed.

", + "description": "

Required. An array of user logins that will be removed.

", "items": { "type": "string" }, @@ -56455,7 +56475,7 @@ "properties": { "name": { "type": "string", - "description": "

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.

", + "description": "

Required. An array of user logins that will be removed.

", "items": { "type": "string" }, @@ -53658,7 +53675,10 @@ "rawDescription": "An array of team `slug`s that will be removed.", "childParamsGroups": [] } - } + }, + "required": [ + "reviewers" + ] }, "example": { "reviewers": [ @@ -53702,7 +53722,7 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

An array of user logins that will be removed.

", + "description": "

Required. An array of user logins that will be removed.

", "items": { "type": "string" }, diff --git a/lib/rest/static/decorated/ghes-2.22.json b/lib/rest/static/decorated/ghes-2.22.json index 4ba0e8477d..04e137bb37 100644 --- a/lib/rest/static/decorated/ghes-2.22.json +++ b/lib/rest/static/decorated/ghes-2.22.json @@ -21134,7 +21134,7 @@ "properties": { "name": { "type": "string", - "description": "

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.

", + "description": "

Required. An array of user logins that will be removed.

", "items": { "type": "string" }, @@ -61202,7 +61219,10 @@ "rawDescription": "An array of team `slug`s that will be removed.", "childParamsGroups": [] } - } + }, + "required": [ + "reviewers" + ] }, "example": { "reviewers": [ @@ -61246,7 +61266,7 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

An array of user logins that will be removed.

", + "description": "

Required. An array of user logins that will be removed.

", "items": { "type": "string" }, diff --git a/lib/rest/static/decorated/ghes-3.0.json b/lib/rest/static/decorated/ghes-3.0.json index 8222c0dadf..4dcc397a91 100644 --- a/lib/rest/static/decorated/ghes-3.0.json +++ b/lib/rest/static/decorated/ghes-3.0.json @@ -25061,7 +25061,7 @@ "properties": { "name": { "type": "string", - "description": "

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.

", + "description": "

Required. An array of user logins that will be removed.

", "items": { "type": "string" }, @@ -65895,7 +65912,10 @@ "rawDescription": "An array of team `slug`s that will be removed.", "childParamsGroups": [] } - } + }, + "required": [ + "reviewers" + ] }, "example": { "reviewers": [ @@ -65939,7 +65959,7 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

An array of user logins that will be removed.

", + "description": "

Required. An array of user logins that will be removed.

", "items": { "type": "string" }, diff --git a/lib/rest/static/decorated/github.ae.json b/lib/rest/static/decorated/github.ae.json index 3580129b6e..224f63c081 100644 --- a/lib/rest/static/decorated/github.ae.json +++ b/lib/rest/static/decorated/github.ae.json @@ -15076,7 +15076,7 @@ "properties": { "name": { "type": "string", - "description": "

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.

", + "description": "

Required. An array of user logins that will be removed.

", "items": { "type": "string" }, @@ -51383,7 +51400,10 @@ "rawDescription": "An array of team `slug`s that will be removed.", "childParamsGroups": [] } - } + }, + "required": [ + "reviewers" + ] }, "example": { "reviewers": [ @@ -51427,7 +51447,7 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

An array of user logins that will be removed.

", + "description": "

Required. An array of user logins that will be removed.

", "items": { "type": "string" }, diff --git a/lib/rest/static/dereferenced/api.github.com.deref.json b/lib/rest/static/dereferenced/api.github.com.deref.json index 8d8e1970a2..1ff8bc8bdf 100644 --- a/lib/rest/static/dereferenced/api.github.com.deref.json +++ b/lib/rest/static/dereferenced/api.github.com.deref.json @@ -79511,12 +79511,10 @@ }, "parent_team_id": { "type": "integer", - "description": "The ID of a team to set as the parent team." + "description": "The ID of a team to set as the parent team.", + "nullable": true } - }, - "required": [ - "name" - ] + } }, "example": { "name": "new team name", @@ -86201,7 +86199,8 @@ "admin" ] } - } + }, + "nullable": true } } } @@ -206000,11 +205999,13 @@ "type": "integer" } ], - "description": "The title of the issue." + "description": "The title of the issue.", + "nullable": true }, "body": { "type": "string", - "description": "The contents of the issue." + "description": "The contents of the issue.", + "nullable": true }, "assignee": { "type": "string", @@ -243291,8 +243292,7 @@ } }, "required": [ - "body", - "path" + "body" ] }, "examples": { @@ -246085,7 +246085,19 @@ "type": "string" } } - } + }, + "anyOf": [ + { + "required": [ + "reviewers" + ] + }, + { + "required": [ + "team_reviewers" + ] + } + ] }, "example": { "reviewers": [ @@ -250195,7 +250207,10 @@ "type": "string" } } - } + }, + "required": [ + "reviewers" + ] }, "example": { "reviewers": [ diff --git a/lib/rest/static/dereferenced/ghes-2.18.deref.json b/lib/rest/static/dereferenced/ghes-2.18.deref.json index 759a1eaef4..c242e015ea 100644 --- a/lib/rest/static/dereferenced/ghes-2.18.deref.json +++ b/lib/rest/static/dereferenced/ghes-2.18.deref.json @@ -144306,11 +144306,13 @@ "type": "integer" } ], - "description": "The title of the issue." + "description": "The title of the issue.", + "nullable": true }, "body": { "type": "string", - "description": "The contents of the issue." + "description": "The contents of the issue.", + "nullable": true }, "assignee": { "type": "string", @@ -183156,7 +183158,19 @@ "type": "string" } } - } + }, + "anyOf": [ + { + "required": [ + "reviewers" + ] + }, + { + "required": [ + "team_reviewers" + ] + } + ] }, "example": { "reviewers": [ @@ -187079,7 +187093,10 @@ "type": "string" } } - } + }, + "required": [ + "reviewers" + ] }, "example": { "reviewers": [ @@ -213210,12 +213227,10 @@ }, "parent_team_id": { "type": "integer", - "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." + "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.", + "nullable": true } - }, - "required": [ - "name" - ] + } }, "example": { "name": "new team name", @@ -219304,7 +219319,8 @@ "admin" ] } - } + }, + "nullable": true } } } diff --git a/lib/rest/static/dereferenced/ghes-2.19.deref.json b/lib/rest/static/dereferenced/ghes-2.19.deref.json index f2e097f8fa..6f74d8d390 100644 --- a/lib/rest/static/dereferenced/ghes-2.19.deref.json +++ b/lib/rest/static/dereferenced/ghes-2.19.deref.json @@ -147543,11 +147543,13 @@ "type": "integer" } ], - "description": "The title of the issue." + "description": "The title of the issue.", + "nullable": true }, "body": { "type": "string", - "description": "The contents of the issue." + "description": "The contents of the issue.", + "nullable": true }, "assignee": { "type": "string", @@ -186555,7 +186557,19 @@ "type": "string" } } - } + }, + "anyOf": [ + { + "required": [ + "reviewers" + ] + }, + { + "required": [ + "team_reviewers" + ] + } + ] }, "example": { "reviewers": [ @@ -190478,7 +190492,10 @@ "type": "string" } } - } + }, + "required": [ + "reviewers" + ] }, "example": { "reviewers": [ @@ -216618,12 +216635,10 @@ }, "parent_team_id": { "type": "integer", - "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." + "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.", + "nullable": true } - }, - "required": [ - "name" - ] + } }, "example": { "name": "new team name", @@ -222528,7 +222543,8 @@ "admin" ] } - } + }, + "nullable": true } } } diff --git a/lib/rest/static/dereferenced/ghes-2.20.deref.json b/lib/rest/static/dereferenced/ghes-2.20.deref.json index 98953903f5..706a31f78c 100644 --- a/lib/rest/static/dereferenced/ghes-2.20.deref.json +++ b/lib/rest/static/dereferenced/ghes-2.20.deref.json @@ -149825,11 +149825,13 @@ "type": "integer" } ], - "description": "The title of the issue." + "description": "The title of the issue.", + "nullable": true }, "body": { "type": "string", - "description": "The contents of the issue." + "description": "The contents of the issue.", + "nullable": true }, "assignee": { "type": "string", @@ -186732,8 +186734,7 @@ } }, "required": [ - "body", - "path" + "body" ] }, "examples": { @@ -189524,7 +189525,19 @@ "type": "string" } } - } + }, + "anyOf": [ + { + "required": [ + "reviewers" + ] + }, + { + "required": [ + "team_reviewers" + ] + } + ] }, "example": { "reviewers": [ @@ -193465,7 +193478,10 @@ "type": "string" } } - } + }, + "required": [ + "reviewers" + ] }, "example": { "reviewers": [ @@ -219683,12 +219699,10 @@ }, "parent_team_id": { "type": "integer", - "description": "The ID of a team to set as the parent team." + "description": "The ID of a team to set as the parent team.", + "nullable": true } - }, - "required": [ - "name" - ] + } }, "example": { "name": "new team name", @@ -225561,7 +225575,8 @@ "admin" ] } - } + }, + "nullable": true } } } diff --git a/lib/rest/static/dereferenced/ghes-2.21.deref.json b/lib/rest/static/dereferenced/ghes-2.21.deref.json index d065a1fb73..f2cfa8201f 100644 --- a/lib/rest/static/dereferenced/ghes-2.21.deref.json +++ b/lib/rest/static/dereferenced/ghes-2.21.deref.json @@ -57904,12 +57904,10 @@ }, "parent_team_id": { "type": "integer", - "description": "The ID of a team to set as the parent team." + "description": "The ID of a team to set as the parent team.", + "nullable": true } - }, - "required": [ - "name" - ] + } }, "example": { "name": "new team name", @@ -64299,7 +64297,8 @@ "admin" ] } - } + }, + "nullable": true } } } @@ -161235,11 +161234,13 @@ "type": "integer" } ], - "description": "The title of the issue." + "description": "The title of the issue.", + "nullable": true }, "body": { "type": "string", - "description": "The contents of the issue." + "description": "The contents of the issue.", + "nullable": true }, "assignee": { "type": "string", @@ -198320,8 +198321,7 @@ } }, "required": [ - "body", - "path" + "body" ] }, "examples": { @@ -201114,7 +201114,19 @@ "type": "string" } } - } + }, + "anyOf": [ + { + "required": [ + "reviewers" + ] + }, + { + "required": [ + "team_reviewers" + ] + } + ] }, "example": { "reviewers": [ @@ -205075,7 +205087,10 @@ "type": "string" } } - } + }, + "required": [ + "reviewers" + ] }, "example": { "reviewers": [ diff --git a/lib/rest/static/dereferenced/ghes-2.22.deref.json b/lib/rest/static/dereferenced/ghes-2.22.deref.json index dbdff5ab03..bf3b1c4ac3 100644 --- a/lib/rest/static/dereferenced/ghes-2.22.deref.json +++ b/lib/rest/static/dereferenced/ghes-2.22.deref.json @@ -68875,12 +68875,10 @@ }, "parent_team_id": { "type": "integer", - "description": "The ID of a team to set as the parent team." + "description": "The ID of a team to set as the parent team.", + "nullable": true } - }, - "required": [ - "name" - ] + } }, "example": { "name": "new team name", @@ -75279,7 +75277,8 @@ "admin" ] } - } + }, + "nullable": true } } } @@ -189624,11 +189623,13 @@ "type": "integer" } ], - "description": "The title of the issue." + "description": "The title of the issue.", + "nullable": true }, "body": { "type": "string", - "description": "The contents of the issue." + "description": "The contents of the issue.", + "nullable": true }, "assignee": { "type": "string", @@ -226720,8 +226721,7 @@ } }, "required": [ - "body", - "path" + "body" ] }, "examples": { @@ -229514,7 +229514,19 @@ "type": "string" } } - } + }, + "anyOf": [ + { + "required": [ + "reviewers" + ] + }, + { + "required": [ + "team_reviewers" + ] + } + ] }, "example": { "reviewers": [ @@ -233479,7 +233491,10 @@ "type": "string" } } - } + }, + "required": [ + "reviewers" + ] }, "example": { "reviewers": [ diff --git a/lib/rest/static/dereferenced/ghes-3.0.deref.json b/lib/rest/static/dereferenced/ghes-3.0.deref.json index 8e93f24407..9688ed6e14 100644 --- a/lib/rest/static/dereferenced/ghes-3.0.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.0.deref.json @@ -73405,12 +73405,10 @@ }, "parent_team_id": { "type": "integer", - "description": "The ID of a team to set as the parent team." + "description": "The ID of a team to set as the parent team.", + "nullable": true } - }, - "required": [ - "name" - ] + } }, "example": { "name": "new team name", @@ -79809,7 +79807,8 @@ "admin" ] } - } + }, + "nullable": true } } } @@ -194950,11 +194949,13 @@ "type": "integer" } ], - "description": "The title of the issue." + "description": "The title of the issue.", + "nullable": true }, "body": { "type": "string", - "description": "The contents of the issue." + "description": "The contents of the issue.", + "nullable": true }, "assignee": { "type": "string", @@ -232046,8 +232047,7 @@ } }, "required": [ - "body", - "path" + "body" ] }, "examples": { @@ -234840,7 +234840,19 @@ "type": "string" } } - } + }, + "anyOf": [ + { + "required": [ + "reviewers" + ] + }, + { + "required": [ + "team_reviewers" + ] + } + ] }, "example": { "reviewers": [ @@ -238805,7 +238817,10 @@ "type": "string" } } - } + }, + "required": [ + "reviewers" + ] }, "example": { "reviewers": [ diff --git a/lib/rest/static/dereferenced/github.ae.deref.json b/lib/rest/static/dereferenced/github.ae.deref.json index 85b56858b9..996250d8db 100644 --- a/lib/rest/static/dereferenced/github.ae.deref.json +++ b/lib/rest/static/dereferenced/github.ae.deref.json @@ -50380,12 +50380,10 @@ }, "parent_team_id": { "type": "integer", - "description": "The ID of a team to set as the parent team." + "description": "The ID of a team to set as the parent team.", + "nullable": true } - }, - "required": [ - "name" - ] + } }, "example": { "name": "new team name", @@ -56785,7 +56783,8 @@ "admin" ] } - } + }, + "nullable": true } } } @@ -154055,11 +154054,13 @@ "type": "integer" } ], - "description": "The title of the issue." + "description": "The title of the issue.", + "nullable": true }, "body": { "type": "string", - "description": "The contents of the issue." + "description": "The contents of the issue.", + "nullable": true }, "assignee": { "type": "string", @@ -191346,8 +191347,7 @@ } }, "required": [ - "body", - "path" + "body" ] }, "examples": { @@ -194140,7 +194140,19 @@ "type": "string" } } - } + }, + "anyOf": [ + { + "required": [ + "reviewers" + ] + }, + { + "required": [ + "team_reviewers" + ] + } + ] }, "example": { "reviewers": [ @@ -198250,7 +198262,10 @@ "type": "string" } } - } + }, + "required": [ + "reviewers" + ] }, "example": { "reviewers": [