Update OpenAPI Descriptions
This commit is contained in:
github-openapi-bot
committed by
GitHub
GitHub
parent
be681aefa5
commit
fc4dec9975
@@ -24167,7 +24167,7 @@
|
||||
"properties": {
|
||||
"name": {
|
||||
"type": "string",
|
||||
"description": "<p><strong>Required</strong>. The name of the team.</p>",
|
||||
"description": "<p>The name of the team.</p>",
|
||||
"name": "name",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
@@ -24212,18 +24212,16 @@
|
||||
"childParamsGroups": []
|
||||
},
|
||||
"parent_team_id": {
|
||||
"type": "integer",
|
||||
"type": "integer or null",
|
||||
"description": "<p>The ID of a team to set as the parent team.</p>",
|
||||
"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": "<p><strong>Required</strong>. The name of the team.</p>",
|
||||
"description": "<p>The name of the team.</p>",
|
||||
"name": "name",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
@@ -24293,8 +24291,9 @@
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"type": "integer",
|
||||
"type": "integer or null",
|
||||
"description": "<p>The ID of a team to set as the parent team.</p>",
|
||||
"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": "<p>The title of the issue.</p>",
|
||||
"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": "<p>The contents of the issue.</p>",
|
||||
"nullable": true,
|
||||
"name": "body",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
@@ -58399,14 +58402,17 @@
|
||||
}
|
||||
],
|
||||
"description": "<p>The title of the issue.</p>",
|
||||
"nullable": true,
|
||||
"name": "title",
|
||||
"in": "body",
|
||||
"rawDescription": "The title of the issue.",
|
||||
"type": "undefined or null",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"type": "string or null",
|
||||
"description": "<p>The contents of the issue.</p>",
|
||||
"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": "<pre><code class=\"hljs language-shell\">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\"}'</code></pre>"
|
||||
"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": "<pre><code class=\"hljs language-shell\">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\"}'</code></pre>"
|
||||
},
|
||||
{
|
||||
"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": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'POST /repos/{owner}/{repo}/pulls/{pull_number}/comments'</span>, {\n <span class=\"hljs-attr\">owner</span>: <span class=\"hljs-string\">'octocat'</span>,\n <span class=\"hljs-attr\">repo</span>: <span class=\"hljs-string\">'hello-world'</span>,\n <span class=\"hljs-attr\">pull_number</span>: <span class=\"hljs-number\">42</span>,\n <span class=\"hljs-attr\">body</span>: <span class=\"hljs-string\">'body'</span>,\n <span class=\"hljs-attr\">path</span>: <span class=\"hljs-string\">'path'</span>\n})\n</code></pre>"
|
||||
"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": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'POST /repos/{owner}/{repo}/pulls/{pull_number}/comments'</span>, {\n <span class=\"hljs-attr\">owner</span>: <span class=\"hljs-string\">'octocat'</span>,\n <span class=\"hljs-attr\">repo</span>: <span class=\"hljs-string\">'hello-world'</span>,\n <span class=\"hljs-attr\">pull_number</span>: <span class=\"hljs-number\">42</span>,\n <span class=\"hljs-attr\">body</span>: <span class=\"hljs-string\">'body'</span>\n})\n</code></pre>"
|
||||
}
|
||||
],
|
||||
"summary": "Create a review comment for a pull request",
|
||||
@@ -65715,7 +65721,7 @@
|
||||
},
|
||||
"path": {
|
||||
"type": "string",
|
||||
"description": "<p><strong>Required</strong>. The relative path to the file that necessitates a comment.</p>",
|
||||
"description": "<p>The relative path to the file that necessitates a comment.</p>",
|
||||
"name": "path",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
@@ -65787,8 +65793,7 @@
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"body",
|
||||
"path"
|
||||
"body"
|
||||
]
|
||||
},
|
||||
"examples": {
|
||||
@@ -65861,7 +65866,7 @@
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"description": "<p><strong>Required</strong>. The relative path to the file that necessitates a comment.</p>",
|
||||
"description": "<p>The relative path to the file that necessitates a comment.</p>",
|
||||
"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": "<p>An array of user <code>login</code>s that will be removed.</p>",
|
||||
"description": "<p><strong>Required</strong>. An array of user <code>login</code>s that will be removed.</p>",
|
||||
"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": "<p>An array of user <code>login</code>s that will be removed.</p>",
|
||||
"description": "<p><strong>Required</strong>. An array of user <code>login</code>s that will be removed.</p>",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
|
||||
Reference in New Issue
Block a user