зеркало из https://github.com/github/docs.git
Merge branch 'main' into patch-1
This commit is contained in:
Shati Patel
GitHub
Коммит
4f302964ad
|
|
@ -21,8 +21,8 @@ package.json @github/docs-engineering
|
|||
/content/github/site-policy/ @github/site-policy-admins
|
||||
|
||||
# Content strategy
|
||||
/contributing/content-markup-reference.md @github/product-docs-content-strategy
|
||||
/contributing/content-style-guide.md @github/product-docs-content-strategy
|
||||
/contributing/content-markup-reference.md @github/docs-content-strategy
|
||||
/contributing/content-style-guide.md @github/docs-content-strategy
|
||||
|
||||
# Make sure that Octokit maintainers get notified about changes
|
||||
# relevant to the Octokit libraries (https://github.com/octokit)
|
||||
|
|
|
|||
Двоичный файл не отображается.
|
После Ширина: | Высота: | Размер: 34 KiB |
Двоичные данные
assets/images/help/package-registry/confirm-container-package-deletion.png
Normal file
Двоичные данные
assets/images/help/package-registry/confirm-container-package-deletion.png
Normal file
Двоичный файл не отображается.
|
После Ширина: | Высота: | Размер: 37 KiB |
Двоичные данные
assets/images/help/package-registry/confirm-container-package-version-deletion.png
Normal file
Двоичные данные
assets/images/help/package-registry/confirm-container-package-version-deletion.png
Normal file
Двоичный файл не отображается.
|
После Ширина: | Высота: | Размер: 38 KiB |
Двоичный файл не отображается.
|
После Ширина: | Высота: | Размер: 14 KiB |
Двоичные данные
assets/images/help/package-registry/delete-container-package-version.png
Normal file
Двоичные данные
assets/images/help/package-registry/delete-container-package-version.png
Normal file
Двоичный файл не отображается.
|
После Ширина: | Высота: | Размер: 92 KiB |
Двоичные данные
assets/images/help/package-registry/delete-package-under-danger-zone.png
Normal file
Двоичные данные
assets/images/help/package-registry/delete-package-under-danger-zone.png
Normal file
Двоичный файл не отображается.
|
После Ширина: | Высота: | Размер: 119 KiB |
Двоичные данные
assets/images/help/package-registry/make-all-container-versions-visible.png
Normal file
Двоичные данные
assets/images/help/package-registry/make-all-container-versions-visible.png
Normal file
Двоичный файл не отображается.
|
После Ширина: | Высота: | Размер: 43 KiB |
Двоичный файл не отображается.
|
После Ширина: | Высота: | Размер: 28 KiB |
Двоичный файл не отображается.
|
После Ширина: | Высота: | Размер: 837 KiB |
Двоичный файл не отображается.
|
После Ширина: | Высота: | Размер: 223 KiB |
|
|
@ -38,12 +38,6 @@ If vulnerabilities have been detected in the repository, these are shown at the
|
|||
{% if enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.21" %}
|
||||
Any direct and indirect dependencies that are specified in the repository's manifest or lock files are listed, grouped by ecosystem. If vulnerabilities have been detected in the repository, these are shown at the top of the view for users with access to {% data variables.product.prodname_dependabot_alerts %}.
|
||||
|
||||
{% note %}
|
||||
|
||||
**Note:** {% data variables.product.prodname_ghe_server %} does not populate the **Dependents** view.
|
||||
|
||||
{% endnote %}
|
||||
|
||||
|
||||
|
||||
{% note %}
|
||||
|
|
@ -57,12 +51,6 @@ Any direct and indirect dependencies that are specified in the repository's mani
|
|||
{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.22" %}
|
||||
Any direct and indirect dependencies that are specified in the repository's manifest or lock files are listed, grouped by ecosystem. If vulnerabilities have been detected in the repository, these are shown at the top of the view for users with access to security alerts.
|
||||
|
||||
{% note %}
|
||||
|
||||
**Note:** {% data variables.product.prodname_ghe_server %} does not populate the **Dependents** view.
|
||||
|
||||
{% endnote %}
|
||||
|
||||
|
||||
|
||||
{% note %}
|
||||
|
|
@ -93,6 +81,25 @@ You can also enable or disable the dependency graph for all repositories owned b
|
|||
|
||||
|
||||
You can disable the dependency graph at any time by clicking **Disable** next to "Dependency Graph" on the Security & analysis tab.
|
||||
|
||||
### Changing the "Used by" package
|
||||
|
||||
If the dependency graph is enabled, and your repository contains a package that's published on a supported package ecosystem, {% data variables.product.prodname_dotcom %} displays a "Used by" section in the sidebar of the **Code** tab of your repository. For more information about the supported package ecosystems, see "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph#supported-package-ecosystems)."
|
||||
|
||||
The "Used by" section shows the number of public references to the package that were found, and displays the avatars of some of the owners of the dependent projects.
|
||||
|
||||
|
||||
|
||||
Clicking any item in this section takes you to the **Dependents** tab of the dependency graph.
|
||||
|
||||
The "Used by" section represents a single package from the repository. If you have admin permissions to a repository that contains multiple packages, you can choose which package the "Used by" section represents.
|
||||
|
||||
{% data reusables.repositories.navigate-to-repo %}
|
||||
{% data reusables.repositories.sidebar-settings %}
|
||||
{% data reusables.repositories.navigate-to-security-and-analysis %}
|
||||
4. Under "Configure security and analysis features", click the drop-down menu in the "Used by counter" section and choose a package.
|
||||
|
||||
|
||||
{% endif %}
|
||||
|
||||
### Troubleshooting the dependency graph
|
||||
|
|
|
|||
|
|
@ -16,6 +16,17 @@ versions:
|
|||
|
||||
{% data reusables.package_registry.admins-can-configure-package-types %}
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}
|
||||
### Limits for published npm versions
|
||||
|
||||
If you publish over 1,000 npm package versions to {% data variables.product.prodname_registry %}, you may see performance issues and timeouts occur during usage.
|
||||
|
||||
To reduce the number of versions you have published for your npm package, consider deleting package versions. For more information, see "[Deleting a package](/packages/manage-packages/deleting-a-package)."
|
||||
|
||||
In the future, {% data variables.product.company_short %} will enforce a hard limit on publishing more than 1,000 versions of an npm package. When we start enforcing the 1,000 versions limit for each npm package hosted on {% data variables.product.prodname_registry %}, we will offer more guidance on how to manage your package versions.
|
||||
|
||||
{% endif %}
|
||||
|
||||
### Authenticating to {% data variables.product.prodname_registry %}
|
||||
|
||||
{% data reusables.package_registry.authenticate-packages %}
|
||||
|
|
|
|||
|
|
@ -1,9 +1,9 @@
|
|||
---
|
||||
title: Deleting a container image
|
||||
intro: 'You can delete a version of a private container image using GraphQL or on {% data variables.product.prodname_dotcom %}.'
|
||||
intro: 'You can delete a specific version or all versions of a private or public container image on {% data variables.product.prodname_dotcom %}.'
|
||||
product: '{% data reusables.gated-features.packages %}'
|
||||
redirect_from:
|
||||
- /packages/managing-container-images-with-github-container-registry/deleting-a-container-image
|
||||
redirect_from:
|
||||
- /packages/managing-container-images-with-github-container-registry/deleting-a-container-image
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
---
|
||||
|
|
@ -20,18 +20,46 @@ When deleting public packages, be aware that you may break projects that depend
|
|||
|
||||
### Deleting a version of a user-owned container image on {% data variables.product.prodname_dotcom %}
|
||||
|
||||
To only delete specific versions of a container image, you can use these steps. To delete an entire package, see "[Deleting all versions of a user-owned container image on {% data variables.product.prodname_dotcom %}](#deleting-all-versions-of-a-user-owned-container-image-on-github)."
|
||||
|
||||
{% data reusables.package_registry.package-settings-from-user-level %}
|
||||
5. On the left, click **Manage versions**.
|
||||
5. To the right of the version you want to delete, click **Delete**.
|
||||
|
||||
6. Optionally, to ensure you're seeing all of your package versions, use the "Type" drop down menu and select **All**.
|
||||
|
||||
5. To the right of the version you want to delete, click {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %} and select **Delete version**.
|
||||
|
||||
6. To confirm deletion, type the package name and click **I understand the consequences, delete this version**.
|
||||
|
||||
|
||||
|
||||
### Deleting a version of an organization-owned container image on {% data variables.product.prodname_dotcom %}
|
||||
|
||||
To only delete specific versions of a container image that you have admin , you can use these steps. To delete an entire package, see "[Deleting all versions of an organization-owned container image on {% data variables.product.prodname_dotcom %}](#deleting-all-versions-of-an-organization-owned-container-image-on-github)."
|
||||
|
||||
{% data reusables.package_registry.package-settings-from-org-level %}
|
||||
5. On the left, click **Manage versions**.
|
||||
5. To the right of the version you want to delete, click **Delete**.
|
||||
|
||||
6. Optionally, to ensure you're seeing all of your package versions, use the "Type" drop down menu and select **All**.
|
||||
|
||||
5. To the right of the version you want to delete, click {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %} and select **Delete version**.
|
||||
|
||||
6. To confirm deletion, type the package name and click **I understand the consequences, delete this version**.
|
||||
|
||||
|
||||
|
||||
### Deleting all versions of a user-owned container image on {% data variables.product.prodname_dotcom %}
|
||||
|
||||
{% data reusables.package_registry.package-settings-from-user-level %}
|
||||
5. On the left, click **Options**.
|
||||
|
||||
6. Under "Danger zone", click **Delete this package**.
|
||||
|
||||
6. To confirm deletion, type the package name and click **I understand the consequences, delete this package**.
|
||||
|
||||
|
||||
### Deleting all versions of an organization-owned container image on {% data variables.product.prodname_dotcom %}
|
||||
|
||||
{% data reusables.package_registry.package-settings-from-org-level %}
|
||||
5. On the left, click **Options**.
|
||||
|
||||
6. Under "Danger zone", click **Delete this package**.
|
||||
|
||||
6. To confirm deletion, type the package name and click **I understand the consequences, delete this package**.
|
||||
|
||||
|
|
|
|||
|
|
@ -135,12 +135,12 @@ _Search_
|
|||
- [`PATCH /repos/:owner/:repo`](/rest/reference/repos#update-a-repository) (:write)
|
||||
- [`DELETE /repos/:owner/:repo`](/rest/reference/repos#delete-a-repository) (:write)
|
||||
{% if currentVersion == "free-pro-team@latest" %}
|
||||
- [`Get GET /repos/:owner/:repo/actions/runners/downloads`](/rest/reference/actions#list-runner-applications-for-a-repository) (:read)
|
||||
- [`GET /repos/:owner/:repo/actions/runners/downloads`](/rest/reference/actions#list-runner-applications-for-a-repository) (:read)
|
||||
- [`GET /repos/:owner/:repo/actions/runners`](/rest/reference/actions#list-self-hosted-runners-for-a-repository) (:read)
|
||||
- [`GET /repos/:owner/:repo/actions/runners/:runner_id`](/rest/reference/actions#get-a-self-hosted-runner-for-a-repository) (:read)
|
||||
- [`DELETE /repos/:owner/:repo/actions/runners/:runner_id`](/rest/reference/actions#delete-a-self-hosted-runner-from-a-repository) (:write)
|
||||
- [`POST /repos/:owner/:repo/actions/runners/registration-token`](/rest/reference/actions#create-a-registration-token-for-a-repository) (:write)
|
||||
- [`POST /repos/:owner/:repo/actions/runners/remove-token`](/rest/reference/actions#create-a-remove-token-for-a-repository) (:write)git
|
||||
- [`POST /repos/:owner/:repo/actions/runners/remove-token`](/rest/reference/actions#create-a-remove-token-for-a-repository) (:write)
|
||||
{% endif %}
|
||||
{% if currentVersion == "free-pro-team@latest" %}
|
||||
- [`PUT /repos/:owner/:repo/automated-security-fixes`](/rest/reference/repos#enable-automated-security-fixes) (:write)
|
||||
|
|
@ -472,7 +472,7 @@ _Assignees_
|
|||
|
||||
_Events_
|
||||
- [`GET /repos/:owner/:repo/issues/:issue_number/events`](/rest/reference/issues#list-issue-events) (:read)
|
||||
- [Get an issue event](/rest/reference/issues#get-an-issue-event) (:read)
|
||||
- [`GET /repos/:owner/:repo/issues/events/:event_id`](/rest/reference/issues#get-an-issue-event) (:read)
|
||||
|
||||
_Labels_
|
||||
- [`GET /repos/:owner/:repo/issues/:issue_number/labels`](/rest/reference/issues#list-labels-for-an-issue) (:read)
|
||||
|
|
|
|||
|
|
@ -14474,13 +14474,13 @@
|
|||
"x-codeSamples": [
|
||||
{
|
||||
"lang": "Shell",
|
||||
"source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/blocks",
|
||||
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/blocks</code></pre>"
|
||||
"source": "curl \\\n -H \"Accept: application/vnd.github.giant-sentry-fist-preview+json\" \\\n https://api.github.com/orgs/ORG/blocks",
|
||||
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -H \"Accept: application/vnd.github.giant-sentry-fist-preview+json\" \\\n https://api.github.com/orgs/ORG/blocks</code></pre>"
|
||||
},
|
||||
{
|
||||
"lang": "JavaScript",
|
||||
"source": "await octokit.request('GET /orgs/{org}/blocks', {\n org: 'org'\n})",
|
||||
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'GET /orgs/{org}/blocks'</span>, {\n <span class=\"hljs-attr\">org</span>: <span class=\"hljs-string\">'org'</span>\n})\n</code></pre>"
|
||||
"source": "await octokit.request('GET /orgs/{org}/blocks', {\n org: 'org',\n mediaType: {\n previews: [\n 'giant-sentry-fist'\n ]\n }\n})",
|
||||
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'GET /orgs/{org}/blocks'</span>, {\n <span class=\"hljs-attr\">org</span>: <span class=\"hljs-string\">'org'</span>,\n <span class=\"hljs-attr\">mediaType</span>: {\n <span class=\"hljs-attr\">previews</span>: [\n <span class=\"hljs-string\">'giant-sentry-fist'</span>\n ]\n }\n})\n</code></pre>"
|
||||
}
|
||||
],
|
||||
"summary": "List users blocked by an organization",
|
||||
|
|
@ -14496,7 +14496,14 @@
|
|||
"x-github": {
|
||||
"githubCloudOnly": false,
|
||||
"enabledForGitHubApps": true,
|
||||
"previews": [],
|
||||
"previews": [
|
||||
{
|
||||
"required": true,
|
||||
"name": "giant-sentry-fist",
|
||||
"note": "The API to block users is currently available for developers to preview. See the [preview notice](https://docs.github.com/rest/overview/api-previews#user-blocking) for more information.\n\nTo access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.giant-sentry-fist-preview+json\n```",
|
||||
"html": "<p>The API to block users is currently available for developers to preview. See the <a href=\"https://docs.github.com/rest/overview/api-previews#user-blocking\">preview notice</a> for more information.</p>\n<p>To access the API during the preview period, you must provide a custom <a href=\"https://docs.github.com/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.giant-sentry-fist-preview+json</code></pre>"
|
||||
}
|
||||
],
|
||||
"category": "orgs",
|
||||
"subcategory": "blocking"
|
||||
},
|
||||
|
|
@ -14549,13 +14556,13 @@
|
|||
"x-codeSamples": [
|
||||
{
|
||||
"lang": "Shell",
|
||||
"source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/blocks/USERNAME",
|
||||
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/blocks/USERNAME</code></pre>"
|
||||
"source": "curl \\\n -H \"Accept: application/vnd.github.giant-sentry-fist-preview+json\" \\\n https://api.github.com/orgs/ORG/blocks/USERNAME",
|
||||
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -H \"Accept: application/vnd.github.giant-sentry-fist-preview+json\" \\\n https://api.github.com/orgs/ORG/blocks/USERNAME</code></pre>"
|
||||
},
|
||||
{
|
||||
"lang": "JavaScript",
|
||||
"source": "await octokit.request('GET /orgs/{org}/blocks/{username}', {\n org: 'org',\n username: 'username'\n})",
|
||||
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'GET /orgs/{org}/blocks/{username}'</span>, {\n <span class=\"hljs-attr\">org</span>: <span class=\"hljs-string\">'org'</span>,\n <span class=\"hljs-attr\">username</span>: <span class=\"hljs-string\">'username'</span>\n})\n</code></pre>"
|
||||
"source": "await octokit.request('GET /orgs/{org}/blocks/{username}', {\n org: 'org',\n username: 'username',\n mediaType: {\n previews: [\n 'giant-sentry-fist'\n ]\n }\n})",
|
||||
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'GET /orgs/{org}/blocks/{username}'</span>, {\n <span class=\"hljs-attr\">org</span>: <span class=\"hljs-string\">'org'</span>,\n <span class=\"hljs-attr\">username</span>: <span class=\"hljs-string\">'username'</span>,\n <span class=\"hljs-attr\">mediaType</span>: {\n <span class=\"hljs-attr\">previews</span>: [\n <span class=\"hljs-string\">'giant-sentry-fist'</span>\n ]\n }\n})\n</code></pre>"
|
||||
}
|
||||
],
|
||||
"summary": "Check if a user is blocked by an organization",
|
||||
|
|
@ -14571,7 +14578,14 @@
|
|||
"x-github": {
|
||||
"githubCloudOnly": false,
|
||||
"enabledForGitHubApps": true,
|
||||
"previews": [],
|
||||
"previews": [
|
||||
{
|
||||
"required": true,
|
||||
"name": "giant-sentry-fist",
|
||||
"note": "The API to block users is currently available for developers to preview. See the [preview notice](https://docs.github.com/rest/overview/api-previews#user-blocking) for more information.\n\nTo access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.giant-sentry-fist-preview+json\n```",
|
||||
"html": "<p>The API to block users is currently available for developers to preview. See the <a href=\"https://docs.github.com/rest/overview/api-previews#user-blocking\">preview notice</a> for more information.</p>\n<p>To access the API during the preview period, you must provide a custom <a href=\"https://docs.github.com/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.giant-sentry-fist-preview+json</code></pre>"
|
||||
}
|
||||
],
|
||||
"category": "orgs",
|
||||
"subcategory": "blocking"
|
||||
},
|
||||
|
|
@ -14623,13 +14637,13 @@
|
|||
"x-codeSamples": [
|
||||
{
|
||||
"lang": "Shell",
|
||||
"source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/blocks/USERNAME",
|
||||
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/blocks/USERNAME</code></pre>"
|
||||
"source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.giant-sentry-fist-preview+json\" \\\n https://api.github.com/orgs/ORG/blocks/USERNAME",
|
||||
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.giant-sentry-fist-preview+json\" \\\n https://api.github.com/orgs/ORG/blocks/USERNAME</code></pre>"
|
||||
},
|
||||
{
|
||||
"lang": "JavaScript",
|
||||
"source": "await octokit.request('PUT /orgs/{org}/blocks/{username}', {\n org: 'org',\n username: 'username'\n})",
|
||||
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'PUT /orgs/{org}/blocks/{username}'</span>, {\n <span class=\"hljs-attr\">org</span>: <span class=\"hljs-string\">'org'</span>,\n <span class=\"hljs-attr\">username</span>: <span class=\"hljs-string\">'username'</span>\n})\n</code></pre>"
|
||||
"source": "await octokit.request('PUT /orgs/{org}/blocks/{username}', {\n org: 'org',\n username: 'username',\n mediaType: {\n previews: [\n 'giant-sentry-fist'\n ]\n }\n})",
|
||||
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'PUT /orgs/{org}/blocks/{username}'</span>, {\n <span class=\"hljs-attr\">org</span>: <span class=\"hljs-string\">'org'</span>,\n <span class=\"hljs-attr\">username</span>: <span class=\"hljs-string\">'username'</span>,\n <span class=\"hljs-attr\">mediaType</span>: {\n <span class=\"hljs-attr\">previews</span>: [\n <span class=\"hljs-string\">'giant-sentry-fist'</span>\n ]\n }\n})\n</code></pre>"
|
||||
}
|
||||
],
|
||||
"summary": "Block a user from an organization",
|
||||
|
|
@ -14645,7 +14659,14 @@
|
|||
"x-github": {
|
||||
"githubCloudOnly": false,
|
||||
"enabledForGitHubApps": true,
|
||||
"previews": [],
|
||||
"previews": [
|
||||
{
|
||||
"required": true,
|
||||
"name": "giant-sentry-fist",
|
||||
"note": "The API to block users is currently available for developers to preview. See the [preview notice](https://docs.github.com/rest/overview/api-previews#user-blocking) for more information.\n\nTo access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.giant-sentry-fist-preview+json\n```",
|
||||
"html": "<p>The API to block users is currently available for developers to preview. See the <a href=\"https://docs.github.com/rest/overview/api-previews#user-blocking\">preview notice</a> for more information.</p>\n<p>To access the API during the preview period, you must provide a custom <a href=\"https://docs.github.com/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.giant-sentry-fist-preview+json</code></pre>"
|
||||
}
|
||||
],
|
||||
"category": "orgs",
|
||||
"subcategory": "blocking"
|
||||
},
|
||||
|
|
@ -14697,13 +14718,13 @@
|
|||
"x-codeSamples": [
|
||||
{
|
||||
"lang": "Shell",
|
||||
"source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/blocks/USERNAME",
|
||||
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/blocks/USERNAME</code></pre>"
|
||||
"source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.giant-sentry-fist-preview+json\" \\\n https://api.github.com/orgs/ORG/blocks/USERNAME",
|
||||
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.giant-sentry-fist-preview+json\" \\\n https://api.github.com/orgs/ORG/blocks/USERNAME</code></pre>"
|
||||
},
|
||||
{
|
||||
"lang": "JavaScript",
|
||||
"source": "await octokit.request('DELETE /orgs/{org}/blocks/{username}', {\n org: 'org',\n username: 'username'\n})",
|
||||
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'DELETE /orgs/{org}/blocks/{username}'</span>, {\n <span class=\"hljs-attr\">org</span>: <span class=\"hljs-string\">'org'</span>,\n <span class=\"hljs-attr\">username</span>: <span class=\"hljs-string\">'username'</span>\n})\n</code></pre>"
|
||||
"source": "await octokit.request('DELETE /orgs/{org}/blocks/{username}', {\n org: 'org',\n username: 'username',\n mediaType: {\n previews: [\n 'giant-sentry-fist'\n ]\n }\n})",
|
||||
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'DELETE /orgs/{org}/blocks/{username}'</span>, {\n <span class=\"hljs-attr\">org</span>: <span class=\"hljs-string\">'org'</span>,\n <span class=\"hljs-attr\">username</span>: <span class=\"hljs-string\">'username'</span>,\n <span class=\"hljs-attr\">mediaType</span>: {\n <span class=\"hljs-attr\">previews</span>: [\n <span class=\"hljs-string\">'giant-sentry-fist'</span>\n ]\n }\n})\n</code></pre>"
|
||||
}
|
||||
],
|
||||
"summary": "Unblock a user from an organization",
|
||||
|
|
@ -14719,7 +14740,14 @@
|
|||
"x-github": {
|
||||
"githubCloudOnly": false,
|
||||
"enabledForGitHubApps": true,
|
||||
"previews": [],
|
||||
"previews": [
|
||||
{
|
||||
"required": true,
|
||||
"name": "giant-sentry-fist",
|
||||
"note": "The API to block users is currently available for developers to preview. See the [preview notice](https://docs.github.com/rest/overview/api-previews#user-blocking) for more information.\n\nTo access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.giant-sentry-fist-preview+json\n```",
|
||||
"html": "<p>The API to block users is currently available for developers to preview. See the <a href=\"https://docs.github.com/rest/overview/api-previews#user-blocking\">preview notice</a> for more information.</p>\n<p>To access the API during the preview period, you must provide a custom <a href=\"https://docs.github.com/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.giant-sentry-fist-preview+json</code></pre>"
|
||||
}
|
||||
],
|
||||
"category": "orgs",
|
||||
"subcategory": "blocking"
|
||||
},
|
||||
|
|
@ -19973,7 +20001,7 @@
|
|||
}
|
||||
],
|
||||
"summary": "Get GitHub Actions billing for an organization",
|
||||
"description": "Gets the summary of the free and paid GitHub Actions minutes used.\n\nPaid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nAccess tokens must have the `read:org` scope.",
|
||||
"description": "Gets the summary of the free and paid GitHub Actions minutes used.\n\nPaid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nAccess tokens must have the `repo` or `admin:org` scope.",
|
||||
"operationId": "billing/get-github-actions-billing-org",
|
||||
"tags": [
|
||||
"billing"
|
||||
|
|
@ -19994,7 +20022,7 @@
|
|||
"categoryLabel": "Billing",
|
||||
"notes": [],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Gets the summary of the free and paid GitHub Actions minutes used.</p>\n<p>Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"<a href=\"https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions\">Managing billing for GitHub Actions</a>\".</p>\n<p>Access tokens must have the <code>read:org</code> scope.</p>",
|
||||
"descriptionHTML": "<p>Gets the summary of the free and paid GitHub Actions minutes used.</p>\n<p>Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"<a href=\"https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions\">Managing billing for GitHub Actions</a>\".</p>\n<p>Access tokens must have the <code>repo</code> or <code>admin:org</code> scope.</p>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
|
|
@ -20032,7 +20060,7 @@
|
|||
}
|
||||
],
|
||||
"summary": "Get GitHub Packages billing for an organization",
|
||||
"description": "Gets the free and paid storage usued for GitHub Packages in gigabytes.\n\nPaid minutes only apply to packages stored for private repositories. For more information, see \"[Managing billing for GitHub Packages](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages).\"\n\nAccess tokens must have the `read:org` scope.",
|
||||
"description": "Gets the free and paid storage usued for GitHub Packages in gigabytes.\n\nPaid minutes only apply to packages stored for private repositories. For more information, see \"[Managing billing for GitHub Packages](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages).\"\n\nAccess tokens must have the `repo` or `admin:org` scope.",
|
||||
"operationId": "billing/get-github-packages-billing-org",
|
||||
"tags": [
|
||||
"billing"
|
||||
|
|
@ -20053,7 +20081,7 @@
|
|||
"categoryLabel": "Billing",
|
||||
"notes": [],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Gets the free and paid storage usued for GitHub Packages in gigabytes.</p>\n<p>Paid minutes only apply to packages stored for private repositories. For more information, see \"<a href=\"https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages\">Managing billing for GitHub Packages</a>.\"</p>\n<p>Access tokens must have the <code>read:org</code> scope.</p>",
|
||||
"descriptionHTML": "<p>Gets the free and paid storage usued for GitHub Packages in gigabytes.</p>\n<p>Paid minutes only apply to packages stored for private repositories. For more information, see \"<a href=\"https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages\">Managing billing for GitHub Packages</a>.\"</p>\n<p>Access tokens must have the <code>repo</code> or <code>admin:org</code> scope.</p>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
|
|
@ -20091,7 +20119,7 @@
|
|||
}
|
||||
],
|
||||
"summary": "Get shared storage billing for an organization",
|
||||
"description": "Gets the estimated paid and estimated total storage used for GitHub Actions and Github Packages.\n\nPaid minutes only apply to packages stored for private repositories. For more information, see \"[Managing billing for GitHub Packages](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages).\"\n\nAccess tokens must have the `read:org` scope.",
|
||||
"description": "Gets the estimated paid and estimated total storage used for GitHub Actions and Github Packages.\n\nPaid minutes only apply to packages stored for private repositories. For more information, see \"[Managing billing for GitHub Packages](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages).\"\n\nAccess tokens must have the `repo` or `admin:org` scope.",
|
||||
"operationId": "billing/get-shared-storage-billing-org",
|
||||
"tags": [
|
||||
"billing"
|
||||
|
|
@ -20112,7 +20140,7 @@
|
|||
"categoryLabel": "Billing",
|
||||
"notes": [],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Gets the estimated paid and estimated total storage used for GitHub Actions and Github Packages.</p>\n<p>Paid minutes only apply to packages stored for private repositories. For more information, see \"<a href=\"https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages\">Managing billing for GitHub Packages</a>.\"</p>\n<p>Access tokens must have the <code>read:org</code> scope.</p>",
|
||||
"descriptionHTML": "<p>Gets the estimated paid and estimated total storage used for GitHub Actions and Github Packages.</p>\n<p>Paid minutes only apply to packages stored for private repositories. For more information, see \"<a href=\"https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages\">Managing billing for GitHub Packages</a>.\"</p>\n<p>Access tokens must have the <code>repo</code> or <code>admin:org</code> scope.</p>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
|
|
@ -60538,7 +60566,7 @@
|
|||
}
|
||||
],
|
||||
"summary": "List review comments in a repository",
|
||||
"description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nLists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/rest/reference/pulls#parameters-2) table.\n\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/rest/reference/reactions) reactions.",
|
||||
"description": "Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.",
|
||||
"tags": [
|
||||
"pulls"
|
||||
],
|
||||
|
|
@ -60554,8 +60582,8 @@
|
|||
{
|
||||
"required": false,
|
||||
"name": "comfort-fade",
|
||||
"note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```",
|
||||
"html": "<p>Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom <a href=\"https://docs.github.com/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.comfort-fade-preview+json</code></pre>"
|
||||
"note": "Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for more information.\n\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```\n\nTo show multi-line comment-supported fields in the response, use the `comfort-fade` preview header and the `line` parameter.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute.",
|
||||
"html": "<p>Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the <a href=\"https://developer.github.com/changes/2019-10-03-multi-line-comments\">blog post</a> for more information.</p>\n<p>To create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom <a href=\"https://docs.github.com/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.comfort-fade-preview+json</code></pre>\n<p>To show multi-line comment-supported fields in the response, use the <code>comfort-fade</code> preview header and the <code>line</code> parameter.</p>\n<p>If you use the <code>comfort-fade</code> preview header, your response will show:</p>\n<ul>\n<li>For multi-line comments, values for <code>start_line</code>, <code>original_start_line</code>, <code>start_side</code>, <code>line</code>, <code>original_line</code>, and <code>side</code>.</li>\n<li>For single-line comments, values for <code>line</code>, <code>original_line</code>, and <code>side</code> and a <code>null</code> value for <code>start_line</code>, <code>original_start_line</code>, and <code>start_side</code>.</li>\n</ul>\n<p>If you don't use the <code>comfort-fade</code> preview header, multi-line and single-line comments will appear the same way in the response with a single <code>position</code> attribute. Your response will show:</p>\n<ul>\n<li>For multi-line comments, the last line of the comment range for the <code>position</code> attribute.</li>\n<li>For single-line comments, the diff-positioned way of referencing comments for the <code>position</code> attribute.</li>\n</ul>"
|
||||
},
|
||||
{
|
||||
"required": false,
|
||||
|
|
@ -60574,7 +60602,7 @@
|
|||
"subcategoryLabel": "Comments",
|
||||
"notes": [],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p><strong>Note:</strong> Multi-line comments on pull requests are currently in public beta and subject to change.</p>\n<p>Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.</p>\n<p><strong>Multi-line comment summary</strong></p>\n<p><strong>Note:</strong> New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the <a href=\"https://developer.github.com/changes/2019-10-03-multi-line-comments\">blog post</a> for full details.</p>\n<p>Use the <code>comfort-fade</code> preview header and the <code>line</code> parameter to show multi-line comment-supported fields in the response.</p>\n<p>If you use the <code>comfort-fade</code> preview header, your response will show:</p>\n<ul>\n<li>For multi-line comments, values for <code>start_line</code>, <code>original_start_line</code>, <code>start_side</code>, <code>line</code>, <code>original_line</code>, and <code>side</code>.</li>\n<li>For single-line comments, values for <code>line</code>, <code>original_line</code>, and <code>side</code> and a <code>null</code> value for <code>start_line</code>, <code>original_start_line</code>, and <code>start_side</code>.</li>\n</ul>\n<p>If you don't use the <code>comfort-fade</code> preview header, multi-line and single-line comments will appear the same way in the response with a single <code>position</code> attribute. Your response will show:</p>\n<ul>\n<li>For multi-line comments, the last line of the comment range for the <code>position</code> attribute.</li>\n<li>For single-line comments, the diff-positioned way of referencing comments for the <code>position</code> attribute. For more information, see <code>position</code> in the <a href=\"https://docs.github.com/rest/reference/pulls#parameters-2\">input parameters</a> table.</li>\n</ul>\n<p>The <code>reactions</code> key will have the following payload where <code>url</code> can be used to construct the API location for <a href=\"https://docs.github.com/rest/reference/reactions\">listing and creating</a> reactions.</p>",
|
||||
"descriptionHTML": "<p>Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.</p>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
|
|
@ -60631,7 +60659,7 @@
|
|||
}
|
||||
],
|
||||
"summary": "Get a review comment for a pull request",
|
||||
"description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nProvides details for a review comment.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/rest/reference/pulls#parameters-2) table.\n\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/rest/reference/reactions) reactions.",
|
||||
"description": "Provides details for a review comment.",
|
||||
"tags": [
|
||||
"pulls"
|
||||
],
|
||||
|
|
@ -60647,8 +60675,8 @@
|
|||
{
|
||||
"required": false,
|
||||
"name": "comfort-fade",
|
||||
"note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```",
|
||||
"html": "<p>Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom <a href=\"https://docs.github.com/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.comfort-fade-preview+json</code></pre>"
|
||||
"note": "Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for more information.\n\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```\n\nTo show multi-line comment-supported fields in the response, use the `comfort-fade` preview header and the `line` parameter.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute.",
|
||||
"html": "<p>Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the <a href=\"https://developer.github.com/changes/2019-10-03-multi-line-comments\">blog post</a> for more information.</p>\n<p>To create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom <a href=\"https://docs.github.com/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.comfort-fade-preview+json</code></pre>\n<p>To show multi-line comment-supported fields in the response, use the <code>comfort-fade</code> preview header and the <code>line</code> parameter.</p>\n<p>If you use the <code>comfort-fade</code> preview header, your response will show:</p>\n<ul>\n<li>For multi-line comments, values for <code>start_line</code>, <code>original_start_line</code>, <code>start_side</code>, <code>line</code>, <code>original_line</code>, and <code>side</code>.</li>\n<li>For single-line comments, values for <code>line</code>, <code>original_line</code>, and <code>side</code> and a <code>null</code> value for <code>start_line</code>, <code>original_start_line</code>, and <code>start_side</code>.</li>\n</ul>\n<p>If you don't use the <code>comfort-fade</code> preview header, multi-line and single-line comments will appear the same way in the response with a single <code>position</code> attribute. Your response will show:</p>\n<ul>\n<li>For multi-line comments, the last line of the comment range for the <code>position</code> attribute.</li>\n<li>For single-line comments, the diff-positioned way of referencing comments for the <code>position</code> attribute.</li>\n</ul>"
|
||||
},
|
||||
{
|
||||
"required": false,
|
||||
|
|
@ -60667,7 +60695,7 @@
|
|||
"subcategoryLabel": "Comments",
|
||||
"notes": [],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p><strong>Note:</strong> Multi-line comments on pull requests are currently in public beta and subject to change.</p>\n<p>Provides details for a review comment.</p>\n<p><strong>Multi-line comment summary</strong></p>\n<p><strong>Note:</strong> New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the <a href=\"https://developer.github.com/changes/2019-10-03-multi-line-comments\">blog post</a> for full details.</p>\n<p>Use the <code>comfort-fade</code> preview header and the <code>line</code> parameter to show multi-line comment-supported fields in the response.</p>\n<p>If you use the <code>comfort-fade</code> preview header, your response will show:</p>\n<ul>\n<li>For multi-line comments, values for <code>start_line</code>, <code>original_start_line</code>, <code>start_side</code>, <code>line</code>, <code>original_line</code>, and <code>side</code>.</li>\n<li>For single-line comments, values for <code>line</code>, <code>original_line</code>, and <code>side</code> and a <code>null</code> value for <code>start_line</code>, <code>original_start_line</code>, and <code>start_side</code>.</li>\n</ul>\n<p>If you don't use the <code>comfort-fade</code> preview header, multi-line and single-line comments will appear the same way in the response with a single <code>position</code> attribute. Your response will show:</p>\n<ul>\n<li>For multi-line comments, the last line of the comment range for the <code>position</code> attribute.</li>\n<li>For single-line comments, the diff-positioned way of referencing comments for the <code>position</code> attribute. For more information, see <code>position</code> in the <a href=\"https://docs.github.com/rest/reference/pulls#parameters-2\">input parameters</a> table.</li>\n</ul>\n<p>The <code>reactions</code> key will have the following payload where <code>url</code> can be used to construct the API location for <a href=\"https://docs.github.com/rest/reference/reactions\">listing and creating</a> reactions.</p>",
|
||||
"descriptionHTML": "<p>Provides details for a review comment.</p>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
|
|
@ -60729,7 +60757,7 @@
|
|||
}
|
||||
],
|
||||
"summary": "Update a review comment for a pull request",
|
||||
"description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nEnables you to edit a review comment.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/rest/reference/pulls#parameters-2) table.",
|
||||
"description": "Enables you to edit a review comment.",
|
||||
"tags": [
|
||||
"pulls"
|
||||
],
|
||||
|
|
@ -60771,8 +60799,8 @@
|
|||
{
|
||||
"required": false,
|
||||
"name": "comfort-fade",
|
||||
"note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```",
|
||||
"html": "<p>Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom <a href=\"https://docs.github.com/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.comfort-fade-preview+json</code></pre>"
|
||||
"note": "Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for more information.\n\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```\n\nTo show multi-line comment-supported fields in the response, use the `comfort-fade` preview header and the `line` parameter.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute.",
|
||||
"html": "<p>Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the <a href=\"https://developer.github.com/changes/2019-10-03-multi-line-comments\">blog post</a> for more information.</p>\n<p>To create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom <a href=\"https://docs.github.com/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.comfort-fade-preview+json</code></pre>\n<p>To show multi-line comment-supported fields in the response, use the <code>comfort-fade</code> preview header and the <code>line</code> parameter.</p>\n<p>If you use the <code>comfort-fade</code> preview header, your response will show:</p>\n<ul>\n<li>For multi-line comments, values for <code>start_line</code>, <code>original_start_line</code>, <code>start_side</code>, <code>line</code>, <code>original_line</code>, and <code>side</code>.</li>\n<li>For single-line comments, values for <code>line</code>, <code>original_line</code>, and <code>side</code> and a <code>null</code> value for <code>start_line</code>, <code>original_start_line</code>, and <code>start_side</code>.</li>\n</ul>\n<p>If you don't use the <code>comfort-fade</code> preview header, multi-line and single-line comments will appear the same way in the response with a single <code>position</code> attribute. Your response will show:</p>\n<ul>\n<li>For multi-line comments, the last line of the comment range for the <code>position</code> attribute.</li>\n<li>For single-line comments, the diff-positioned way of referencing comments for the <code>position</code> attribute.</li>\n</ul>"
|
||||
}
|
||||
],
|
||||
"category": "pulls",
|
||||
|
|
@ -60784,7 +60812,7 @@
|
|||
"subcategory": "comments",
|
||||
"subcategoryLabel": "Comments",
|
||||
"notes": [],
|
||||
"descriptionHTML": "<p><strong>Note:</strong> Multi-line comments on pull requests are currently in public beta and subject to change.</p>\n<p>Enables you to edit a review comment.</p>\n<p><strong>Multi-line comment summary</strong></p>\n<p><strong>Note:</strong> New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the <a href=\"https://developer.github.com/changes/2019-10-03-multi-line-comments\">blog post</a> for full details.</p>\n<p>Use the <code>comfort-fade</code> preview header and the <code>line</code> parameter to show multi-line comment-supported fields in the response.</p>\n<p>If you use the <code>comfort-fade</code> preview header, your response will show:</p>\n<ul>\n<li>For multi-line comments, values for <code>start_line</code>, <code>original_start_line</code>, <code>start_side</code>, <code>line</code>, <code>original_line</code>, and <code>side</code>.</li>\n<li>For single-line comments, values for <code>line</code>, <code>original_line</code>, and <code>side</code> and a <code>null</code> value for <code>start_line</code>, <code>original_start_line</code>, and <code>start_side</code>.</li>\n</ul>\n<p>If you don't use the <code>comfort-fade</code> preview header, multi-line and single-line comments will appear the same way in the response with a single <code>position</code> attribute. Your response will show:</p>\n<ul>\n<li>For multi-line comments, the last line of the comment range for the <code>position</code> attribute.</li>\n<li>For single-line comments, the diff-positioned way of referencing comments for the <code>position</code> attribute. For more information, see <code>position</code> in the <a href=\"https://docs.github.com/rest/reference/pulls#parameters-2\">input parameters</a> table.</li>\n</ul>",
|
||||
"descriptionHTML": "<p>Enables you to edit a review comment.</p>",
|
||||
"bodyParameters": [
|
||||
{
|
||||
"type": "string",
|
||||
|
|
@ -61674,7 +61702,7 @@
|
|||
}
|
||||
],
|
||||
"summary": "List review comments on a pull request",
|
||||
"description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nLists all review comments for a pull request. By default, review comments are in ascending order by ID.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/rest/reference/pulls#parameters-2) table.\n\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/rest/reference/reactions) reactions.",
|
||||
"description": "Lists all review comments for a pull request. By default, review comments are in ascending order by ID.",
|
||||
"tags": [
|
||||
"pulls"
|
||||
],
|
||||
|
|
@ -61690,8 +61718,8 @@
|
|||
{
|
||||
"required": false,
|
||||
"name": "comfort-fade",
|
||||
"note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```",
|
||||
"html": "<p>Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom <a href=\"https://docs.github.com/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.comfort-fade-preview+json</code></pre>"
|
||||
"note": "Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for more information.\n\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```\n\nTo show multi-line comment-supported fields in the response, use the `comfort-fade` preview header and the `line` parameter.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute.",
|
||||
"html": "<p>Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the <a href=\"https://developer.github.com/changes/2019-10-03-multi-line-comments\">blog post</a> for more information.</p>\n<p>To create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom <a href=\"https://docs.github.com/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.comfort-fade-preview+json</code></pre>\n<p>To show multi-line comment-supported fields in the response, use the <code>comfort-fade</code> preview header and the <code>line</code> parameter.</p>\n<p>If you use the <code>comfort-fade</code> preview header, your response will show:</p>\n<ul>\n<li>For multi-line comments, values for <code>start_line</code>, <code>original_start_line</code>, <code>start_side</code>, <code>line</code>, <code>original_line</code>, and <code>side</code>.</li>\n<li>For single-line comments, values for <code>line</code>, <code>original_line</code>, and <code>side</code> and a <code>null</code> value for <code>start_line</code>, <code>original_start_line</code>, and <code>start_side</code>.</li>\n</ul>\n<p>If you don't use the <code>comfort-fade</code> preview header, multi-line and single-line comments will appear the same way in the response with a single <code>position</code> attribute. Your response will show:</p>\n<ul>\n<li>For multi-line comments, the last line of the comment range for the <code>position</code> attribute.</li>\n<li>For single-line comments, the diff-positioned way of referencing comments for the <code>position</code> attribute.</li>\n</ul>"
|
||||
},
|
||||
{
|
||||
"required": false,
|
||||
|
|
@ -61710,7 +61738,7 @@
|
|||
"subcategoryLabel": "Comments",
|
||||
"notes": [],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p><strong>Note:</strong> Multi-line comments on pull requests are currently in public beta and subject to change.</p>\n<p>Lists all review comments for a pull request. By default, review comments are in ascending order by ID.</p>\n<p><strong>Multi-line comment summary</strong></p>\n<p><strong>Note:</strong> New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the <a href=\"https://developer.github.com/changes/2019-10-03-multi-line-comments\">blog post</a> for full details.</p>\n<p>Use the <code>comfort-fade</code> preview header and the <code>line</code> parameter to show multi-line comment-supported fields in the response.</p>\n<p>If you use the <code>comfort-fade</code> preview header, your response will show:</p>\n<ul>\n<li>For multi-line comments, values for <code>start_line</code>, <code>original_start_line</code>, <code>start_side</code>, <code>line</code>, <code>original_line</code>, and <code>side</code>.</li>\n<li>For single-line comments, values for <code>line</code>, <code>original_line</code>, and <code>side</code> and a <code>null</code> value for <code>start_line</code>, <code>original_start_line</code>, and <code>start_side</code>.</li>\n</ul>\n<p>If you don't use the <code>comfort-fade</code> preview header, multi-line and single-line comments will appear the same way in the response with a single <code>position</code> attribute. Your response will show:</p>\n<ul>\n<li>For multi-line comments, the last line of the comment range for the <code>position</code> attribute.</li>\n<li>For single-line comments, the diff-positioned way of referencing comments for the <code>position</code> attribute. For more information, see <code>position</code> in the <a href=\"https://docs.github.com/rest/reference/pulls#parameters-2\">input parameters</a> table.</li>\n</ul>\n<p>The <code>reactions</code> key will have the following payload where <code>url</code> can be used to construct the API location for <a href=\"https://docs.github.com/rest/reference/reactions\">listing and creating</a> reactions.</p>",
|
||||
"descriptionHTML": "<p>Lists all review comments for a pull request. By default, review comments are in ascending order by ID.</p>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
|
|
@ -61766,7 +61794,7 @@
|
|||
}
|
||||
],
|
||||
"summary": "Create a review comment for a pull request",
|
||||
"description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nCreates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"[Create an issue comment](https://docs.github.com/rest/reference/issues#create-an-issue-comment).\" We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff.\n\nYou can still create a review comment using the `position` parameter. When you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. For more information, see [Multi-line comment summary](https://docs.github.com/rest/reference/pulls#multi-line-comment-summary-3).\n\n**Note:** The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/rest/reference/pulls#parameters-2) table.",
|
||||
"description": "\nCreates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"[Create an issue comment](https://docs.github.com/rest/reference/issues#create-an-issue-comment).\" We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff.\n\nYou can still create a review comment using the `position` parameter. When you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. For more information, see the [`comfort-fade` preview notice](https://docs.github.com/rest/reference/pulls#create-a-review-comment-for-a-pull-request-preview-notices).\n\n**Note:** The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.",
|
||||
"tags": [
|
||||
"pulls"
|
||||
],
|
||||
|
|
@ -61912,8 +61940,8 @@
|
|||
{
|
||||
"required": false,
|
||||
"name": "comfort-fade",
|
||||
"note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```",
|
||||
"html": "<p>Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom <a href=\"https://docs.github.com/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.comfort-fade-preview+json</code></pre>"
|
||||
"note": "Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for more information.\n\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```\n\nTo show multi-line comment-supported fields in the response, use the `comfort-fade` preview header and the `line` parameter.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute.",
|
||||
"html": "<p>Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the <a href=\"https://developer.github.com/changes/2019-10-03-multi-line-comments\">blog post</a> for more information.</p>\n<p>To create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom <a href=\"https://docs.github.com/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.comfort-fade-preview+json</code></pre>\n<p>To show multi-line comment-supported fields in the response, use the <code>comfort-fade</code> preview header and the <code>line</code> parameter.</p>\n<p>If you use the <code>comfort-fade</code> preview header, your response will show:</p>\n<ul>\n<li>For multi-line comments, values for <code>start_line</code>, <code>original_start_line</code>, <code>start_side</code>, <code>line</code>, <code>original_line</code>, and <code>side</code>.</li>\n<li>For single-line comments, values for <code>line</code>, <code>original_line</code>, and <code>side</code> and a <code>null</code> value for <code>start_line</code>, <code>original_start_line</code>, and <code>start_side</code>.</li>\n</ul>\n<p>If you don't use the <code>comfort-fade</code> preview header, multi-line and single-line comments will appear the same way in the response with a single <code>position</code> attribute. Your response will show:</p>\n<ul>\n<li>For multi-line comments, the last line of the comment range for the <code>position</code> attribute.</li>\n<li>For single-line comments, the diff-positioned way of referencing comments for the <code>position</code> attribute.</li>\n</ul>"
|
||||
}
|
||||
],
|
||||
"category": "pulls",
|
||||
|
|
@ -61925,7 +61953,7 @@
|
|||
"subcategory": "comments",
|
||||
"subcategoryLabel": "Comments",
|
||||
"notes": [],
|
||||
"descriptionHTML": "<p><strong>Note:</strong> Multi-line comments on pull requests are currently in public beta and subject to change.</p>\n<p>Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"<a href=\"https://docs.github.com/rest/reference/issues#create-an-issue-comment\">Create an issue comment</a>.\" We recommend creating a review comment using <code>line</code>, <code>side</code>, and optionally <code>start_line</code> and <code>start_side</code> if your comment applies to more than one line in the pull request diff.</p>\n<p>You can still create a review comment using the <code>position</code> parameter. When you use <code>position</code>, the <code>line</code>, <code>side</code>, <code>start_line</code>, and <code>start_side</code> parameters are not required. For more information, see <a href=\"https://docs.github.com/rest/reference/pulls#multi-line-comment-summary-3\">Multi-line comment summary</a>.</p>\n<p><strong>Note:</strong> The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.</p>\n<p>This endpoint triggers <a href=\"https://help.github.com/articles/about-notifications/\">notifications</a>. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"<a href=\"https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits\">Abuse rate limits</a>\" and \"<a href=\"https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits\">Dealing with abuse rate limits</a>\" for details.</p>\n<p><strong>Multi-line comment summary</strong></p>\n<p><strong>Note:</strong> New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the <a href=\"https://developer.github.com/changes/2019-10-03-multi-line-comments\">blog post</a> for full details.</p>\n<p>Use the <code>comfort-fade</code> preview header and the <code>line</code> parameter to show multi-line comment-supported fields in the response.</p>\n<p>If you use the <code>comfort-fade</code> preview header, your response will show:</p>\n<ul>\n<li>For multi-line comments, values for <code>start_line</code>, <code>original_start_line</code>, <code>start_side</code>, <code>line</code>, <code>original_line</code>, and <code>side</code>.</li>\n<li>For single-line comments, values for <code>line</code>, <code>original_line</code>, and <code>side</code> and a <code>null</code> value for <code>start_line</code>, <code>original_start_line</code>, and <code>start_side</code>.</li>\n</ul>\n<p>If you don't use the <code>comfort-fade</code> preview header, multi-line and single-line comments will appear the same way in the response with a single <code>position</code> attribute. Your response will show:</p>\n<ul>\n<li>For multi-line comments, the last line of the comment range for the <code>position</code> attribute.</li>\n<li>For single-line comments, the diff-positioned way of referencing comments for the <code>position</code> attribute. For more information, see <code>position</code> in the <a href=\"https://docs.github.com/rest/reference/pulls#parameters-2\">input parameters</a> table.</li>\n</ul>",
|
||||
"descriptionHTML": "<p>Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"<a href=\"https://docs.github.com/rest/reference/issues#create-an-issue-comment\">Create an issue comment</a>.\" We recommend creating a review comment using <code>line</code>, <code>side</code>, and optionally <code>start_line</code> and <code>start_side</code> if your comment applies to more than one line in the pull request diff.</p>\n<p>You can still create a review comment using the <code>position</code> parameter. When you use <code>position</code>, the <code>line</code>, <code>side</code>, <code>start_line</code>, and <code>start_side</code> parameters are not required. For more information, see the <a href=\"https://docs.github.com/rest/reference/pulls#create-a-review-comment-for-a-pull-request-preview-notices\"><code>comfort-fade</code> preview notice</a>.</p>\n<p><strong>Note:</strong> The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.</p>\n<p>This endpoint triggers <a href=\"https://help.github.com/articles/about-notifications/\">notifications</a>. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"<a href=\"https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits\">Abuse rate limits</a>\" and \"<a href=\"https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits\">Dealing with abuse rate limits</a>\" for details.</p>",
|
||||
"bodyParameters": [
|
||||
{
|
||||
"type": "string",
|
||||
|
|
@ -78073,13 +78101,13 @@
|
|||
"x-codeSamples": [
|
||||
{
|
||||
"lang": "Shell",
|
||||
"source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/blocks",
|
||||
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/blocks</code></pre>"
|
||||
"source": "curl \\\n -H \"Accept: application/vnd.github.giant-sentry-fist-preview+json\" \\\n https://api.github.com/user/blocks",
|
||||
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -H \"Accept: application/vnd.github.giant-sentry-fist-preview+json\" \\\n https://api.github.com/user/blocks</code></pre>"
|
||||
},
|
||||
{
|
||||
"lang": "JavaScript",
|
||||
"source": "await octokit.request('GET /user/blocks')",
|
||||
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'GET /user/blocks'</span>)\n</code></pre>"
|
||||
"source": "await octokit.request('GET /user/blocks', {\n mediaType: {\n previews: [\n 'giant-sentry-fist'\n ]\n }\n})",
|
||||
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'GET /user/blocks'</span>, {\n <span class=\"hljs-attr\">mediaType</span>: {\n <span class=\"hljs-attr\">previews</span>: [\n <span class=\"hljs-string\">'giant-sentry-fist'</span>\n ]\n }\n})\n</code></pre>"
|
||||
}
|
||||
],
|
||||
"summary": "List users blocked by the authenticated user",
|
||||
|
|
@ -78095,7 +78123,14 @@
|
|||
"x-github": {
|
||||
"githubCloudOnly": false,
|
||||
"enabledForGitHubApps": false,
|
||||
"previews": [],
|
||||
"previews": [
|
||||
{
|
||||
"required": true,
|
||||
"name": "giant-sentry-fist",
|
||||
"note": "The API to block users is currently available for developers to preview. See the [preview notice](https://docs.github.com/rest/overview/api-previews#user-blocking) for more information.\n\nTo access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.giant-sentry-fist-preview+json\n```",
|
||||
"html": "<p>The API to block users is currently available for developers to preview. See the <a href=\"https://docs.github.com/rest/overview/api-previews#user-blocking\">preview notice</a> for more information.</p>\n<p>To access the API during the preview period, you must provide a custom <a href=\"https://docs.github.com/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.giant-sentry-fist-preview+json</code></pre>"
|
||||
}
|
||||
],
|
||||
"category": "users",
|
||||
"subcategory": "blocking"
|
||||
},
|
||||
|
|
@ -78159,17 +78194,17 @@
|
|||
"x-codeSamples": [
|
||||
{
|
||||
"lang": "Shell",
|
||||
"source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/blocks/USERNAME",
|
||||
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/blocks/USERNAME</code></pre>"
|
||||
"source": "curl \\\n -H \"Accept: application/vnd.github.giant-sentry-fist-preview+json\" \\\n https://api.github.com/user/blocks/USERNAME",
|
||||
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -H \"Accept: application/vnd.github.giant-sentry-fist-preview+json\" \\\n https://api.github.com/user/blocks/USERNAME</code></pre>"
|
||||
},
|
||||
{
|
||||
"lang": "JavaScript",
|
||||
"source": "await octokit.request('GET /user/blocks/{username}', {\n username: 'username'\n})",
|
||||
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'GET /user/blocks/{username}'</span>, {\n <span class=\"hljs-attr\">username</span>: <span class=\"hljs-string\">'username'</span>\n})\n</code></pre>"
|
||||
"source": "await octokit.request('GET /user/blocks/{username}', {\n username: 'username',\n mediaType: {\n previews: [\n 'giant-sentry-fist'\n ]\n }\n})",
|
||||
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'GET /user/blocks/{username}'</span>, {\n <span class=\"hljs-attr\">username</span>: <span class=\"hljs-string\">'username'</span>,\n <span class=\"hljs-attr\">mediaType</span>: {\n <span class=\"hljs-attr\">previews</span>: [\n <span class=\"hljs-string\">'giant-sentry-fist'</span>\n ]\n }\n})\n</code></pre>"
|
||||
}
|
||||
],
|
||||
"summary": "Check if a user is blocked by the authenticated user",
|
||||
"description": "If the user is blocked:\n\nIf the user is not blocked:",
|
||||
"description": "",
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
|
|
@ -78181,7 +78216,14 @@
|
|||
"x-github": {
|
||||
"githubCloudOnly": false,
|
||||
"enabledForGitHubApps": false,
|
||||
"previews": [],
|
||||
"previews": [
|
||||
{
|
||||
"required": true,
|
||||
"name": "giant-sentry-fist",
|
||||
"note": "The API to block users is currently available for developers to preview. See the [preview notice](https://docs.github.com/rest/overview/api-previews#user-blocking) for more information.\n\nTo access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.giant-sentry-fist-preview+json\n```",
|
||||
"html": "<p>The API to block users is currently available for developers to preview. See the <a href=\"https://docs.github.com/rest/overview/api-previews#user-blocking\">preview notice</a> for more information.</p>\n<p>To access the API during the preview period, you must provide a custom <a href=\"https://docs.github.com/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.giant-sentry-fist-preview+json</code></pre>"
|
||||
}
|
||||
],
|
||||
"category": "users",
|
||||
"subcategory": "blocking"
|
||||
},
|
||||
|
|
@ -78219,7 +78261,7 @@
|
|||
}
|
||||
],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>If the user is blocked:</p>\n<p>If the user is not blocked:</p>"
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"verb": "put",
|
||||
|
|
@ -78239,13 +78281,13 @@
|
|||
"x-codeSamples": [
|
||||
{
|
||||
"lang": "Shell",
|
||||
"source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/blocks/USERNAME",
|
||||
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/blocks/USERNAME</code></pre>"
|
||||
"source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.giant-sentry-fist-preview+json\" \\\n https://api.github.com/user/blocks/USERNAME",
|
||||
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.giant-sentry-fist-preview+json\" \\\n https://api.github.com/user/blocks/USERNAME</code></pre>"
|
||||
},
|
||||
{
|
||||
"lang": "JavaScript",
|
||||
"source": "await octokit.request('PUT /user/blocks/{username}', {\n username: 'username'\n})",
|
||||
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'PUT /user/blocks/{username}'</span>, {\n <span class=\"hljs-attr\">username</span>: <span class=\"hljs-string\">'username'</span>\n})\n</code></pre>"
|
||||
"source": "await octokit.request('PUT /user/blocks/{username}', {\n username: 'username',\n mediaType: {\n previews: [\n 'giant-sentry-fist'\n ]\n }\n})",
|
||||
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'PUT /user/blocks/{username}'</span>, {\n <span class=\"hljs-attr\">username</span>: <span class=\"hljs-string\">'username'</span>,\n <span class=\"hljs-attr\">mediaType</span>: {\n <span class=\"hljs-attr\">previews</span>: [\n <span class=\"hljs-string\">'giant-sentry-fist'</span>\n ]\n }\n})\n</code></pre>"
|
||||
}
|
||||
],
|
||||
"summary": "Block a user",
|
||||
|
|
@ -78261,7 +78303,14 @@
|
|||
"x-github": {
|
||||
"githubCloudOnly": false,
|
||||
"enabledForGitHubApps": false,
|
||||
"previews": [],
|
||||
"previews": [
|
||||
{
|
||||
"required": true,
|
||||
"name": "giant-sentry-fist",
|
||||
"note": "The API to block users is currently available for developers to preview. See the [preview notice](https://docs.github.com/rest/overview/api-previews#user-blocking) for more information.\n\nTo access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.giant-sentry-fist-preview+json\n```",
|
||||
"html": "<p>The API to block users is currently available for developers to preview. See the <a href=\"https://docs.github.com/rest/overview/api-previews#user-blocking\">preview notice</a> for more information.</p>\n<p>To access the API during the preview period, you must provide a custom <a href=\"https://docs.github.com/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.giant-sentry-fist-preview+json</code></pre>"
|
||||
}
|
||||
],
|
||||
"category": "users",
|
||||
"subcategory": "blocking"
|
||||
},
|
||||
|
|
@ -78324,13 +78373,13 @@
|
|||
"x-codeSamples": [
|
||||
{
|
||||
"lang": "Shell",
|
||||
"source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/blocks/USERNAME",
|
||||
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/blocks/USERNAME</code></pre>"
|
||||
"source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.giant-sentry-fist-preview+json\" \\\n https://api.github.com/user/blocks/USERNAME",
|
||||
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.giant-sentry-fist-preview+json\" \\\n https://api.github.com/user/blocks/USERNAME</code></pre>"
|
||||
},
|
||||
{
|
||||
"lang": "JavaScript",
|
||||
"source": "await octokit.request('DELETE /user/blocks/{username}', {\n username: 'username'\n})",
|
||||
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'DELETE /user/blocks/{username}'</span>, {\n <span class=\"hljs-attr\">username</span>: <span class=\"hljs-string\">'username'</span>\n})\n</code></pre>"
|
||||
"source": "await octokit.request('DELETE /user/blocks/{username}', {\n username: 'username',\n mediaType: {\n previews: [\n 'giant-sentry-fist'\n ]\n }\n})",
|
||||
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'DELETE /user/blocks/{username}'</span>, {\n <span class=\"hljs-attr\">username</span>: <span class=\"hljs-string\">'username'</span>,\n <span class=\"hljs-attr\">mediaType</span>: {\n <span class=\"hljs-attr\">previews</span>: [\n <span class=\"hljs-string\">'giant-sentry-fist'</span>\n ]\n }\n})\n</code></pre>"
|
||||
}
|
||||
],
|
||||
"summary": "Unblock a user",
|
||||
|
|
@ -78346,7 +78395,14 @@
|
|||
"x-github": {
|
||||
"githubCloudOnly": false,
|
||||
"enabledForGitHubApps": false,
|
||||
"previews": [],
|
||||
"previews": [
|
||||
{
|
||||
"required": true,
|
||||
"name": "giant-sentry-fist",
|
||||
"note": "The API to block users is currently available for developers to preview. See the [preview notice](https://docs.github.com/rest/overview/api-previews#user-blocking) for more information.\n\nTo access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.giant-sentry-fist-preview+json\n```",
|
||||
"html": "<p>The API to block users is currently available for developers to preview. See the <a href=\"https://docs.github.com/rest/overview/api-previews#user-blocking\">preview notice</a> for more information.</p>\n<p>To access the API during the preview period, you must provide a custom <a href=\"https://docs.github.com/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.giant-sentry-fist-preview+json</code></pre>"
|
||||
}
|
||||
],
|
||||
"category": "users",
|
||||
"subcategory": "blocking"
|
||||
},
|
||||
|
|
@ -82516,11 +82572,6 @@
|
|||
"httpStatusMessage": "Forbidden",
|
||||
"description": "Forbidden"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "418",
|
||||
"httpStatusMessage": "I'm A Teapot",
|
||||
"description": "Response definition missing"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "422",
|
||||
"httpStatusMessage": "Unprocessable Entity",
|
||||
|
|
|
|||
|
|
@ -44376,7 +44376,7 @@
|
|||
}
|
||||
],
|
||||
"summary": "List review comments in a repository",
|
||||
"description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nLists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/enterprise-server@2.18/rest/reference/pulls#parameters-2) table.\n\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions) reactions.",
|
||||
"description": "Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.",
|
||||
"tags": [
|
||||
"pulls"
|
||||
],
|
||||
|
|
@ -44392,8 +44392,8 @@
|
|||
{
|
||||
"required": false,
|
||||
"name": "comfort-fade",
|
||||
"note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```",
|
||||
"html": "<p>Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.18/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.comfort-fade-preview+json</code></pre>"
|
||||
"note": "Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for more information.\n\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```\n\nTo show multi-line comment-supported fields in the response, use the `comfort-fade` preview header and the `line` parameter.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute.",
|
||||
"html": "<p>Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the <a href=\"https://developer.github.com/changes/2019-10-03-multi-line-comments\">blog post</a> for more information.</p>\n<p>To create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.18/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.comfort-fade-preview+json</code></pre>\n<p>To show multi-line comment-supported fields in the response, use the <code>comfort-fade</code> preview header and the <code>line</code> parameter.</p>\n<p>If you use the <code>comfort-fade</code> preview header, your response will show:</p>\n<ul>\n<li>For multi-line comments, values for <code>start_line</code>, <code>original_start_line</code>, <code>start_side</code>, <code>line</code>, <code>original_line</code>, and <code>side</code>.</li>\n<li>For single-line comments, values for <code>line</code>, <code>original_line</code>, and <code>side</code> and a <code>null</code> value for <code>start_line</code>, <code>original_start_line</code>, and <code>start_side</code>.</li>\n</ul>\n<p>If you don't use the <code>comfort-fade</code> preview header, multi-line and single-line comments will appear the same way in the response with a single <code>position</code> attribute. Your response will show:</p>\n<ul>\n<li>For multi-line comments, the last line of the comment range for the <code>position</code> attribute.</li>\n<li>For single-line comments, the diff-positioned way of referencing comments for the <code>position</code> attribute.</li>\n</ul>"
|
||||
},
|
||||
{
|
||||
"required": false,
|
||||
|
|
@ -44412,7 +44412,7 @@
|
|||
"subcategoryLabel": "Comments",
|
||||
"notes": [],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p><strong>Note:</strong> Multi-line comments on pull requests are currently in public beta and subject to change.</p>\n<p>Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.</p>\n<p><strong>Multi-line comment summary</strong></p>\n<p><strong>Note:</strong> New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the <a href=\"https://developer.github.com/changes/2019-10-03-multi-line-comments\">blog post</a> for full details.</p>\n<p>Use the <code>comfort-fade</code> preview header and the <code>line</code> parameter to show multi-line comment-supported fields in the response.</p>\n<p>If you use the <code>comfort-fade</code> preview header, your response will show:</p>\n<ul>\n<li>For multi-line comments, values for <code>start_line</code>, <code>original_start_line</code>, <code>start_side</code>, <code>line</code>, <code>original_line</code>, and <code>side</code>.</li>\n<li>For single-line comments, values for <code>line</code>, <code>original_line</code>, and <code>side</code> and a <code>null</code> value for <code>start_line</code>, <code>original_start_line</code>, and <code>start_side</code>.</li>\n</ul>\n<p>If you don't use the <code>comfort-fade</code> preview header, multi-line and single-line comments will appear the same way in the response with a single <code>position</code> attribute. Your response will show:</p>\n<ul>\n<li>For multi-line comments, the last line of the comment range for the <code>position</code> attribute.</li>\n<li>For single-line comments, the diff-positioned way of referencing comments for the <code>position</code> attribute. For more information, see <code>position</code> in the <a href=\"https://docs.github.com/enterprise-server@2.18/rest/reference/pulls#parameters-2\">input parameters</a> table.</li>\n</ul>\n<p>The <code>reactions</code> key will have the following payload where <code>url</code> can be used to construct the API location for <a href=\"https://docs.github.com/enterprise-server@2.18/rest/reference/reactions\">listing and creating</a> reactions.</p>",
|
||||
"descriptionHTML": "<p>Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.</p>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
|
|
@ -44469,7 +44469,7 @@
|
|||
}
|
||||
],
|
||||
"summary": "Get a review comment for a pull request",
|
||||
"description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nProvides details for a review comment.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/enterprise-server@2.18/rest/reference/pulls#parameters-2) table.\n\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions) reactions.",
|
||||
"description": "Provides details for a review comment.",
|
||||
"tags": [
|
||||
"pulls"
|
||||
],
|
||||
|
|
@ -44485,8 +44485,8 @@
|
|||
{
|
||||
"required": false,
|
||||
"name": "comfort-fade",
|
||||
"note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```",
|
||||
"html": "<p>Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.18/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.comfort-fade-preview+json</code></pre>"
|
||||
"note": "Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for more information.\n\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```\n\nTo show multi-line comment-supported fields in the response, use the `comfort-fade` preview header and the `line` parameter.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute.",
|
||||
"html": "<p>Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the <a href=\"https://developer.github.com/changes/2019-10-03-multi-line-comments\">blog post</a> for more information.</p>\n<p>To create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.18/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.comfort-fade-preview+json</code></pre>\n<p>To show multi-line comment-supported fields in the response, use the <code>comfort-fade</code> preview header and the <code>line</code> parameter.</p>\n<p>If you use the <code>comfort-fade</code> preview header, your response will show:</p>\n<ul>\n<li>For multi-line comments, values for <code>start_line</code>, <code>original_start_line</code>, <code>start_side</code>, <code>line</code>, <code>original_line</code>, and <code>side</code>.</li>\n<li>For single-line comments, values for <code>line</code>, <code>original_line</code>, and <code>side</code> and a <code>null</code> value for <code>start_line</code>, <code>original_start_line</code>, and <code>start_side</code>.</li>\n</ul>\n<p>If you don't use the <code>comfort-fade</code> preview header, multi-line and single-line comments will appear the same way in the response with a single <code>position</code> attribute. Your response will show:</p>\n<ul>\n<li>For multi-line comments, the last line of the comment range for the <code>position</code> attribute.</li>\n<li>For single-line comments, the diff-positioned way of referencing comments for the <code>position</code> attribute.</li>\n</ul>"
|
||||
},
|
||||
{
|
||||
"required": false,
|
||||
|
|
@ -44505,7 +44505,7 @@
|
|||
"subcategoryLabel": "Comments",
|
||||
"notes": [],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p><strong>Note:</strong> Multi-line comments on pull requests are currently in public beta and subject to change.</p>\n<p>Provides details for a review comment.</p>\n<p><strong>Multi-line comment summary</strong></p>\n<p><strong>Note:</strong> New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the <a href=\"https://developer.github.com/changes/2019-10-03-multi-line-comments\">blog post</a> for full details.</p>\n<p>Use the <code>comfort-fade</code> preview header and the <code>line</code> parameter to show multi-line comment-supported fields in the response.</p>\n<p>If you use the <code>comfort-fade</code> preview header, your response will show:</p>\n<ul>\n<li>For multi-line comments, values for <code>start_line</code>, <code>original_start_line</code>, <code>start_side</code>, <code>line</code>, <code>original_line</code>, and <code>side</code>.</li>\n<li>For single-line comments, values for <code>line</code>, <code>original_line</code>, and <code>side</code> and a <code>null</code> value for <code>start_line</code>, <code>original_start_line</code>, and <code>start_side</code>.</li>\n</ul>\n<p>If you don't use the <code>comfort-fade</code> preview header, multi-line and single-line comments will appear the same way in the response with a single <code>position</code> attribute. Your response will show:</p>\n<ul>\n<li>For multi-line comments, the last line of the comment range for the <code>position</code> attribute.</li>\n<li>For single-line comments, the diff-positioned way of referencing comments for the <code>position</code> attribute. For more information, see <code>position</code> in the <a href=\"https://docs.github.com/enterprise-server@2.18/rest/reference/pulls#parameters-2\">input parameters</a> table.</li>\n</ul>\n<p>The <code>reactions</code> key will have the following payload where <code>url</code> can be used to construct the API location for <a href=\"https://docs.github.com/enterprise-server@2.18/rest/reference/reactions\">listing and creating</a> reactions.</p>",
|
||||
"descriptionHTML": "<p>Provides details for a review comment.</p>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
|
|
@ -44567,7 +44567,7 @@
|
|||
}
|
||||
],
|
||||
"summary": "Update a review comment for a pull request",
|
||||
"description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nEnables you to edit a review comment.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/enterprise-server@2.18/rest/reference/pulls#parameters-2) table.",
|
||||
"description": "Enables you to edit a review comment.",
|
||||
"tags": [
|
||||
"pulls"
|
||||
],
|
||||
|
|
@ -44609,8 +44609,8 @@
|
|||
{
|
||||
"required": false,
|
||||
"name": "comfort-fade",
|
||||
"note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```",
|
||||
"html": "<p>Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.18/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.comfort-fade-preview+json</code></pre>"
|
||||
"note": "Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for more information.\n\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```\n\nTo show multi-line comment-supported fields in the response, use the `comfort-fade` preview header and the `line` parameter.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute.",
|
||||
"html": "<p>Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the <a href=\"https://developer.github.com/changes/2019-10-03-multi-line-comments\">blog post</a> for more information.</p>\n<p>To create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.18/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.comfort-fade-preview+json</code></pre>\n<p>To show multi-line comment-supported fields in the response, use the <code>comfort-fade</code> preview header and the <code>line</code> parameter.</p>\n<p>If you use the <code>comfort-fade</code> preview header, your response will show:</p>\n<ul>\n<li>For multi-line comments, values for <code>start_line</code>, <code>original_start_line</code>, <code>start_side</code>, <code>line</code>, <code>original_line</code>, and <code>side</code>.</li>\n<li>For single-line comments, values for <code>line</code>, <code>original_line</code>, and <code>side</code> and a <code>null</code> value for <code>start_line</code>, <code>original_start_line</code>, and <code>start_side</code>.</li>\n</ul>\n<p>If you don't use the <code>comfort-fade</code> preview header, multi-line and single-line comments will appear the same way in the response with a single <code>position</code> attribute. Your response will show:</p>\n<ul>\n<li>For multi-line comments, the last line of the comment range for the <code>position</code> attribute.</li>\n<li>For single-line comments, the diff-positioned way of referencing comments for the <code>position</code> attribute.</li>\n</ul>"
|
||||
}
|
||||
],
|
||||
"category": "pulls",
|
||||
|
|
@ -44622,7 +44622,7 @@
|
|||
"subcategory": "comments",
|
||||
"subcategoryLabel": "Comments",
|
||||
"notes": [],
|
||||
"descriptionHTML": "<p><strong>Note:</strong> Multi-line comments on pull requests are currently in public beta and subject to change.</p>\n<p>Enables you to edit a review comment.</p>\n<p><strong>Multi-line comment summary</strong></p>\n<p><strong>Note:</strong> New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the <a href=\"https://developer.github.com/changes/2019-10-03-multi-line-comments\">blog post</a> for full details.</p>\n<p>Use the <code>comfort-fade</code> preview header and the <code>line</code> parameter to show multi-line comment-supported fields in the response.</p>\n<p>If you use the <code>comfort-fade</code> preview header, your response will show:</p>\n<ul>\n<li>For multi-line comments, values for <code>start_line</code>, <code>original_start_line</code>, <code>start_side</code>, <code>line</code>, <code>original_line</code>, and <code>side</code>.</li>\n<li>For single-line comments, values for <code>line</code>, <code>original_line</code>, and <code>side</code> and a <code>null</code> value for <code>start_line</code>, <code>original_start_line</code>, and <code>start_side</code>.</li>\n</ul>\n<p>If you don't use the <code>comfort-fade</code> preview header, multi-line and single-line comments will appear the same way in the response with a single <code>position</code> attribute. Your response will show:</p>\n<ul>\n<li>For multi-line comments, the last line of the comment range for the <code>position</code> attribute.</li>\n<li>For single-line comments, the diff-positioned way of referencing comments for the <code>position</code> attribute. For more information, see <code>position</code> in the <a href=\"https://docs.github.com/enterprise-server@2.18/rest/reference/pulls#parameters-2\">input parameters</a> table.</li>\n</ul>",
|
||||
"descriptionHTML": "<p>Enables you to edit a review comment.</p>",
|
||||
"bodyParameters": [
|
||||
{
|
||||
"type": "string",
|
||||
|
|
@ -45431,7 +45431,7 @@
|
|||
}
|
||||
],
|
||||
"summary": "List review comments on a pull request",
|
||||
"description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nLists all review comments for a pull request. By default, review comments are in ascending order by ID.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/enterprise-server@2.18/rest/reference/pulls#parameters-2) table.\n\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions) reactions.",
|
||||
"description": "Lists all review comments for a pull request. By default, review comments are in ascending order by ID.",
|
||||
"tags": [
|
||||
"pulls"
|
||||
],
|
||||
|
|
@ -45447,8 +45447,8 @@
|
|||
{
|
||||
"required": false,
|
||||
"name": "comfort-fade",
|
||||
"note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```",
|
||||
"html": "<p>Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.18/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.comfort-fade-preview+json</code></pre>"
|
||||
"note": "Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for more information.\n\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```\n\nTo show multi-line comment-supported fields in the response, use the `comfort-fade` preview header and the `line` parameter.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute.",
|
||||
"html": "<p>Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the <a href=\"https://developer.github.com/changes/2019-10-03-multi-line-comments\">blog post</a> for more information.</p>\n<p>To create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.18/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.comfort-fade-preview+json</code></pre>\n<p>To show multi-line comment-supported fields in the response, use the <code>comfort-fade</code> preview header and the <code>line</code> parameter.</p>\n<p>If you use the <code>comfort-fade</code> preview header, your response will show:</p>\n<ul>\n<li>For multi-line comments, values for <code>start_line</code>, <code>original_start_line</code>, <code>start_side</code>, <code>line</code>, <code>original_line</code>, and <code>side</code>.</li>\n<li>For single-line comments, values for <code>line</code>, <code>original_line</code>, and <code>side</code> and a <code>null</code> value for <code>start_line</code>, <code>original_start_line</code>, and <code>start_side</code>.</li>\n</ul>\n<p>If you don't use the <code>comfort-fade</code> preview header, multi-line and single-line comments will appear the same way in the response with a single <code>position</code> attribute. Your response will show:</p>\n<ul>\n<li>For multi-line comments, the last line of the comment range for the <code>position</code> attribute.</li>\n<li>For single-line comments, the diff-positioned way of referencing comments for the <code>position</code> attribute.</li>\n</ul>"
|
||||
},
|
||||
{
|
||||
"required": false,
|
||||
|
|
@ -45467,7 +45467,7 @@
|
|||
"subcategoryLabel": "Comments",
|
||||
"notes": [],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p><strong>Note:</strong> Multi-line comments on pull requests are currently in public beta and subject to change.</p>\n<p>Lists all review comments for a pull request. By default, review comments are in ascending order by ID.</p>\n<p><strong>Multi-line comment summary</strong></p>\n<p><strong>Note:</strong> New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the <a href=\"https://developer.github.com/changes/2019-10-03-multi-line-comments\">blog post</a> for full details.</p>\n<p>Use the <code>comfort-fade</code> preview header and the <code>line</code> parameter to show multi-line comment-supported fields in the response.</p>\n<p>If you use the <code>comfort-fade</code> preview header, your response will show:</p>\n<ul>\n<li>For multi-line comments, values for <code>start_line</code>, <code>original_start_line</code>, <code>start_side</code>, <code>line</code>, <code>original_line</code>, and <code>side</code>.</li>\n<li>For single-line comments, values for <code>line</code>, <code>original_line</code>, and <code>side</code> and a <code>null</code> value for <code>start_line</code>, <code>original_start_line</code>, and <code>start_side</code>.</li>\n</ul>\n<p>If you don't use the <code>comfort-fade</code> preview header, multi-line and single-line comments will appear the same way in the response with a single <code>position</code> attribute. Your response will show:</p>\n<ul>\n<li>For multi-line comments, the last line of the comment range for the <code>position</code> attribute.</li>\n<li>For single-line comments, the diff-positioned way of referencing comments for the <code>position</code> attribute. For more information, see <code>position</code> in the <a href=\"https://docs.github.com/enterprise-server@2.18/rest/reference/pulls#parameters-2\">input parameters</a> table.</li>\n</ul>\n<p>The <code>reactions</code> key will have the following payload where <code>url</code> can be used to construct the API location for <a href=\"https://docs.github.com/enterprise-server@2.18/rest/reference/reactions\">listing and creating</a> reactions.</p>",
|
||||
"descriptionHTML": "<p>Lists all review comments for a pull request. By default, review comments are in ascending order by ID.</p>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
|
|
@ -60104,11 +60104,6 @@
|
|||
"httpStatusMessage": "Forbidden",
|
||||
"description": "Forbidden"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "418",
|
||||
"httpStatusMessage": "I'm A Teapot",
|
||||
"description": "Response definition missing"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "422",
|
||||
"httpStatusMessage": "Unprocessable Entity",
|
||||
|
|
|
|||
|
|
@ -45172,7 +45172,7 @@
|
|||
}
|
||||
],
|
||||
"summary": "List review comments in a repository",
|
||||
"description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nLists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/enterprise-server@2.19/rest/reference/pulls#parameters-2) table.\n\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.19/rest/reference/reactions) reactions.",
|
||||
"description": "Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.",
|
||||
"tags": [
|
||||
"pulls"
|
||||
],
|
||||
|
|
@ -45188,8 +45188,8 @@
|
|||
{
|
||||
"required": false,
|
||||
"name": "comfort-fade",
|
||||
"note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```",
|
||||
"html": "<p>Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.19/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.comfort-fade-preview+json</code></pre>"
|
||||
"note": "Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for more information.\n\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```\n\nTo show multi-line comment-supported fields in the response, use the `comfort-fade` preview header and the `line` parameter.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute.",
|
||||
"html": "<p>Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the <a href=\"https://developer.github.com/changes/2019-10-03-multi-line-comments\">blog post</a> for more information.</p>\n<p>To create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.19/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.comfort-fade-preview+json</code></pre>\n<p>To show multi-line comment-supported fields in the response, use the <code>comfort-fade</code> preview header and the <code>line</code> parameter.</p>\n<p>If you use the <code>comfort-fade</code> preview header, your response will show:</p>\n<ul>\n<li>For multi-line comments, values for <code>start_line</code>, <code>original_start_line</code>, <code>start_side</code>, <code>line</code>, <code>original_line</code>, and <code>side</code>.</li>\n<li>For single-line comments, values for <code>line</code>, <code>original_line</code>, and <code>side</code> and a <code>null</code> value for <code>start_line</code>, <code>original_start_line</code>, and <code>start_side</code>.</li>\n</ul>\n<p>If you don't use the <code>comfort-fade</code> preview header, multi-line and single-line comments will appear the same way in the response with a single <code>position</code> attribute. Your response will show:</p>\n<ul>\n<li>For multi-line comments, the last line of the comment range for the <code>position</code> attribute.</li>\n<li>For single-line comments, the diff-positioned way of referencing comments for the <code>position</code> attribute.</li>\n</ul>"
|
||||
},
|
||||
{
|
||||
"required": false,
|
||||
|
|
@ -45208,7 +45208,7 @@
|
|||
"subcategoryLabel": "Comments",
|
||||
"notes": [],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p><strong>Note:</strong> Multi-line comments on pull requests are currently in public beta and subject to change.</p>\n<p>Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.</p>\n<p><strong>Multi-line comment summary</strong></p>\n<p><strong>Note:</strong> New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the <a href=\"https://developer.github.com/changes/2019-10-03-multi-line-comments\">blog post</a> for full details.</p>\n<p>Use the <code>comfort-fade</code> preview header and the <code>line</code> parameter to show multi-line comment-supported fields in the response.</p>\n<p>If you use the <code>comfort-fade</code> preview header, your response will show:</p>\n<ul>\n<li>For multi-line comments, values for <code>start_line</code>, <code>original_start_line</code>, <code>start_side</code>, <code>line</code>, <code>original_line</code>, and <code>side</code>.</li>\n<li>For single-line comments, values for <code>line</code>, <code>original_line</code>, and <code>side</code> and a <code>null</code> value for <code>start_line</code>, <code>original_start_line</code>, and <code>start_side</code>.</li>\n</ul>\n<p>If you don't use the <code>comfort-fade</code> preview header, multi-line and single-line comments will appear the same way in the response with a single <code>position</code> attribute. Your response will show:</p>\n<ul>\n<li>For multi-line comments, the last line of the comment range for the <code>position</code> attribute.</li>\n<li>For single-line comments, the diff-positioned way of referencing comments for the <code>position</code> attribute. For more information, see <code>position</code> in the <a href=\"https://docs.github.com/enterprise-server@2.19/rest/reference/pulls#parameters-2\">input parameters</a> table.</li>\n</ul>\n<p>The <code>reactions</code> key will have the following payload where <code>url</code> can be used to construct the API location for <a href=\"https://docs.github.com/enterprise-server@2.19/rest/reference/reactions\">listing and creating</a> reactions.</p>",
|
||||
"descriptionHTML": "<p>Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.</p>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
|
|
@ -45265,7 +45265,7 @@
|
|||
}
|
||||
],
|
||||
"summary": "Get a review comment for a pull request",
|
||||
"description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nProvides details for a review comment.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/enterprise-server@2.19/rest/reference/pulls#parameters-2) table.\n\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.19/rest/reference/reactions) reactions.",
|
||||
"description": "Provides details for a review comment.",
|
||||
"tags": [
|
||||
"pulls"
|
||||
],
|
||||
|
|
@ -45281,8 +45281,8 @@
|
|||
{
|
||||
"required": false,
|
||||
"name": "comfort-fade",
|
||||
"note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```",
|
||||
"html": "<p>Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.19/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.comfort-fade-preview+json</code></pre>"
|
||||
"note": "Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for more information.\n\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```\n\nTo show multi-line comment-supported fields in the response, use the `comfort-fade` preview header and the `line` parameter.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute.",
|
||||
"html": "<p>Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the <a href=\"https://developer.github.com/changes/2019-10-03-multi-line-comments\">blog post</a> for more information.</p>\n<p>To create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.19/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.comfort-fade-preview+json</code></pre>\n<p>To show multi-line comment-supported fields in the response, use the <code>comfort-fade</code> preview header and the <code>line</code> parameter.</p>\n<p>If you use the <code>comfort-fade</code> preview header, your response will show:</p>\n<ul>\n<li>For multi-line comments, values for <code>start_line</code>, <code>original_start_line</code>, <code>start_side</code>, <code>line</code>, <code>original_line</code>, and <code>side</code>.</li>\n<li>For single-line comments, values for <code>line</code>, <code>original_line</code>, and <code>side</code> and a <code>null</code> value for <code>start_line</code>, <code>original_start_line</code>, and <code>start_side</code>.</li>\n</ul>\n<p>If you don't use the <code>comfort-fade</code> preview header, multi-line and single-line comments will appear the same way in the response with a single <code>position</code> attribute. Your response will show:</p>\n<ul>\n<li>For multi-line comments, the last line of the comment range for the <code>position</code> attribute.</li>\n<li>For single-line comments, the diff-positioned way of referencing comments for the <code>position</code> attribute.</li>\n</ul>"
|
||||
},
|
||||
{
|
||||
"required": false,
|
||||
|
|
@ -45301,7 +45301,7 @@
|
|||
"subcategoryLabel": "Comments",
|
||||
"notes": [],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p><strong>Note:</strong> Multi-line comments on pull requests are currently in public beta and subject to change.</p>\n<p>Provides details for a review comment.</p>\n<p><strong>Multi-line comment summary</strong></p>\n<p><strong>Note:</strong> New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the <a href=\"https://developer.github.com/changes/2019-10-03-multi-line-comments\">blog post</a> for full details.</p>\n<p>Use the <code>comfort-fade</code> preview header and the <code>line</code> parameter to show multi-line comment-supported fields in the response.</p>\n<p>If you use the <code>comfort-fade</code> preview header, your response will show:</p>\n<ul>\n<li>For multi-line comments, values for <code>start_line</code>, <code>original_start_line</code>, <code>start_side</code>, <code>line</code>, <code>original_line</code>, and <code>side</code>.</li>\n<li>For single-line comments, values for <code>line</code>, <code>original_line</code>, and <code>side</code> and a <code>null</code> value for <code>start_line</code>, <code>original_start_line</code>, and <code>start_side</code>.</li>\n</ul>\n<p>If you don't use the <code>comfort-fade</code> preview header, multi-line and single-line comments will appear the same way in the response with a single <code>position</code> attribute. Your response will show:</p>\n<ul>\n<li>For multi-line comments, the last line of the comment range for the <code>position</code> attribute.</li>\n<li>For single-line comments, the diff-positioned way of referencing comments for the <code>position</code> attribute. For more information, see <code>position</code> in the <a href=\"https://docs.github.com/enterprise-server@2.19/rest/reference/pulls#parameters-2\">input parameters</a> table.</li>\n</ul>\n<p>The <code>reactions</code> key will have the following payload where <code>url</code> can be used to construct the API location for <a href=\"https://docs.github.com/enterprise-server@2.19/rest/reference/reactions\">listing and creating</a> reactions.</p>",
|
||||
"descriptionHTML": "<p>Provides details for a review comment.</p>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
|
|
@ -45363,7 +45363,7 @@
|
|||
}
|
||||
],
|
||||
"summary": "Update a review comment for a pull request",
|
||||
"description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nEnables you to edit a review comment.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/enterprise-server@2.19/rest/reference/pulls#parameters-2) table.",
|
||||
"description": "Enables you to edit a review comment.",
|
||||
"tags": [
|
||||
"pulls"
|
||||
],
|
||||
|
|
@ -45405,8 +45405,8 @@
|
|||
{
|
||||
"required": false,
|
||||
"name": "comfort-fade",
|
||||
"note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```",
|
||||
"html": "<p>Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.19/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.comfort-fade-preview+json</code></pre>"
|
||||
"note": "Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for more information.\n\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```\n\nTo show multi-line comment-supported fields in the response, use the `comfort-fade` preview header and the `line` parameter.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute.",
|
||||
"html": "<p>Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the <a href=\"https://developer.github.com/changes/2019-10-03-multi-line-comments\">blog post</a> for more information.</p>\n<p>To create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.19/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.comfort-fade-preview+json</code></pre>\n<p>To show multi-line comment-supported fields in the response, use the <code>comfort-fade</code> preview header and the <code>line</code> parameter.</p>\n<p>If you use the <code>comfort-fade</code> preview header, your response will show:</p>\n<ul>\n<li>For multi-line comments, values for <code>start_line</code>, <code>original_start_line</code>, <code>start_side</code>, <code>line</code>, <code>original_line</code>, and <code>side</code>.</li>\n<li>For single-line comments, values for <code>line</code>, <code>original_line</code>, and <code>side</code> and a <code>null</code> value for <code>start_line</code>, <code>original_start_line</code>, and <code>start_side</code>.</li>\n</ul>\n<p>If you don't use the <code>comfort-fade</code> preview header, multi-line and single-line comments will appear the same way in the response with a single <code>position</code> attribute. Your response will show:</p>\n<ul>\n<li>For multi-line comments, the last line of the comment range for the <code>position</code> attribute.</li>\n<li>For single-line comments, the diff-positioned way of referencing comments for the <code>position</code> attribute.</li>\n</ul>"
|
||||
}
|
||||
],
|
||||
"category": "pulls",
|
||||
|
|
@ -45418,7 +45418,7 @@
|
|||
"subcategory": "comments",
|
||||
"subcategoryLabel": "Comments",
|
||||
"notes": [],
|
||||
"descriptionHTML": "<p><strong>Note:</strong> Multi-line comments on pull requests are currently in public beta and subject to change.</p>\n<p>Enables you to edit a review comment.</p>\n<p><strong>Multi-line comment summary</strong></p>\n<p><strong>Note:</strong> New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the <a href=\"https://developer.github.com/changes/2019-10-03-multi-line-comments\">blog post</a> for full details.</p>\n<p>Use the <code>comfort-fade</code> preview header and the <code>line</code> parameter to show multi-line comment-supported fields in the response.</p>\n<p>If you use the <code>comfort-fade</code> preview header, your response will show:</p>\n<ul>\n<li>For multi-line comments, values for <code>start_line</code>, <code>original_start_line</code>, <code>start_side</code>, <code>line</code>, <code>original_line</code>, and <code>side</code>.</li>\n<li>For single-line comments, values for <code>line</code>, <code>original_line</code>, and <code>side</code> and a <code>null</code> value for <code>start_line</code>, <code>original_start_line</code>, and <code>start_side</code>.</li>\n</ul>\n<p>If you don't use the <code>comfort-fade</code> preview header, multi-line and single-line comments will appear the same way in the response with a single <code>position</code> attribute. Your response will show:</p>\n<ul>\n<li>For multi-line comments, the last line of the comment range for the <code>position</code> attribute.</li>\n<li>For single-line comments, the diff-positioned way of referencing comments for the <code>position</code> attribute. For more information, see <code>position</code> in the <a href=\"https://docs.github.com/enterprise-server@2.19/rest/reference/pulls#parameters-2\">input parameters</a> table.</li>\n</ul>",
|
||||
"descriptionHTML": "<p>Enables you to edit a review comment.</p>",
|
||||
"bodyParameters": [
|
||||
{
|
||||
"type": "string",
|
||||
|
|
@ -46227,7 +46227,7 @@
|
|||
}
|
||||
],
|
||||
"summary": "List review comments on a pull request",
|
||||
"description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nLists all review comments for a pull request. By default, review comments are in ascending order by ID.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/enterprise-server@2.19/rest/reference/pulls#parameters-2) table.\n\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.19/rest/reference/reactions) reactions.",
|
||||
"description": "Lists all review comments for a pull request. By default, review comments are in ascending order by ID.",
|
||||
"tags": [
|
||||
"pulls"
|
||||
],
|
||||
|
|
@ -46243,8 +46243,8 @@
|
|||
{
|
||||
"required": false,
|
||||
"name": "comfort-fade",
|
||||
"note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```",
|
||||
"html": "<p>Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.19/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.comfort-fade-preview+json</code></pre>"
|
||||
"note": "Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for more information.\n\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```\n\nTo show multi-line comment-supported fields in the response, use the `comfort-fade` preview header and the `line` parameter.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute.",
|
||||
"html": "<p>Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the <a href=\"https://developer.github.com/changes/2019-10-03-multi-line-comments\">blog post</a> for more information.</p>\n<p>To create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.19/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.comfort-fade-preview+json</code></pre>\n<p>To show multi-line comment-supported fields in the response, use the <code>comfort-fade</code> preview header and the <code>line</code> parameter.</p>\n<p>If you use the <code>comfort-fade</code> preview header, your response will show:</p>\n<ul>\n<li>For multi-line comments, values for <code>start_line</code>, <code>original_start_line</code>, <code>start_side</code>, <code>line</code>, <code>original_line</code>, and <code>side</code>.</li>\n<li>For single-line comments, values for <code>line</code>, <code>original_line</code>, and <code>side</code> and a <code>null</code> value for <code>start_line</code>, <code>original_start_line</code>, and <code>start_side</code>.</li>\n</ul>\n<p>If you don't use the <code>comfort-fade</code> preview header, multi-line and single-line comments will appear the same way in the response with a single <code>position</code> attribute. Your response will show:</p>\n<ul>\n<li>For multi-line comments, the last line of the comment range for the <code>position</code> attribute.</li>\n<li>For single-line comments, the diff-positioned way of referencing comments for the <code>position</code> attribute.</li>\n</ul>"
|
||||
},
|
||||
{
|
||||
"required": false,
|
||||
|
|
@ -46263,7 +46263,7 @@
|
|||
"subcategoryLabel": "Comments",
|
||||
"notes": [],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p><strong>Note:</strong> Multi-line comments on pull requests are currently in public beta and subject to change.</p>\n<p>Lists all review comments for a pull request. By default, review comments are in ascending order by ID.</p>\n<p><strong>Multi-line comment summary</strong></p>\n<p><strong>Note:</strong> New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the <a href=\"https://developer.github.com/changes/2019-10-03-multi-line-comments\">blog post</a> for full details.</p>\n<p>Use the <code>comfort-fade</code> preview header and the <code>line</code> parameter to show multi-line comment-supported fields in the response.</p>\n<p>If you use the <code>comfort-fade</code> preview header, your response will show:</p>\n<ul>\n<li>For multi-line comments, values for <code>start_line</code>, <code>original_start_line</code>, <code>start_side</code>, <code>line</code>, <code>original_line</code>, and <code>side</code>.</li>\n<li>For single-line comments, values for <code>line</code>, <code>original_line</code>, and <code>side</code> and a <code>null</code> value for <code>start_line</code>, <code>original_start_line</code>, and <code>start_side</code>.</li>\n</ul>\n<p>If you don't use the <code>comfort-fade</code> preview header, multi-line and single-line comments will appear the same way in the response with a single <code>position</code> attribute. Your response will show:</p>\n<ul>\n<li>For multi-line comments, the last line of the comment range for the <code>position</code> attribute.</li>\n<li>For single-line comments, the diff-positioned way of referencing comments for the <code>position</code> attribute. For more information, see <code>position</code> in the <a href=\"https://docs.github.com/enterprise-server@2.19/rest/reference/pulls#parameters-2\">input parameters</a> table.</li>\n</ul>\n<p>The <code>reactions</code> key will have the following payload where <code>url</code> can be used to construct the API location for <a href=\"https://docs.github.com/enterprise-server@2.19/rest/reference/reactions\">listing and creating</a> reactions.</p>",
|
||||
"descriptionHTML": "<p>Lists all review comments for a pull request. By default, review comments are in ascending order by ID.</p>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
|
|
@ -60688,11 +60688,6 @@
|
|||
"httpStatusMessage": "Forbidden",
|
||||
"description": "Forbidden"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "418",
|
||||
"httpStatusMessage": "I'm A Teapot",
|
||||
"description": "Response definition missing"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "422",
|
||||
"httpStatusMessage": "Unprocessable Entity",
|
||||
|
|
|
|||
|
|
@ -45639,7 +45639,7 @@
|
|||
}
|
||||
],
|
||||
"summary": "List review comments in a repository",
|
||||
"description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nLists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/enterprise-server@2.20/rest/reference/pulls#parameters-2) table.\n\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.20/rest/reference/reactions) reactions.",
|
||||
"description": "Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.",
|
||||
"tags": [
|
||||
"pulls"
|
||||
],
|
||||
|
|
@ -45655,8 +45655,8 @@
|
|||
{
|
||||
"required": false,
|
||||
"name": "comfort-fade",
|
||||
"note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.20/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```",
|
||||
"html": "<p>Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.20/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.comfort-fade-preview+json</code></pre>"
|
||||
"note": "Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for more information.\n\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.20/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```\n\nTo show multi-line comment-supported fields in the response, use the `comfort-fade` preview header and the `line` parameter.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute.",
|
||||
"html": "<p>Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the <a href=\"https://developer.github.com/changes/2019-10-03-multi-line-comments\">blog post</a> for more information.</p>\n<p>To create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.20/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.comfort-fade-preview+json</code></pre>\n<p>To show multi-line comment-supported fields in the response, use the <code>comfort-fade</code> preview header and the <code>line</code> parameter.</p>\n<p>If you use the <code>comfort-fade</code> preview header, your response will show:</p>\n<ul>\n<li>For multi-line comments, values for <code>start_line</code>, <code>original_start_line</code>, <code>start_side</code>, <code>line</code>, <code>original_line</code>, and <code>side</code>.</li>\n<li>For single-line comments, values for <code>line</code>, <code>original_line</code>, and <code>side</code> and a <code>null</code> value for <code>start_line</code>, <code>original_start_line</code>, and <code>start_side</code>.</li>\n</ul>\n<p>If you don't use the <code>comfort-fade</code> preview header, multi-line and single-line comments will appear the same way in the response with a single <code>position</code> attribute. Your response will show:</p>\n<ul>\n<li>For multi-line comments, the last line of the comment range for the <code>position</code> attribute.</li>\n<li>For single-line comments, the diff-positioned way of referencing comments for the <code>position</code> attribute.</li>\n</ul>"
|
||||
},
|
||||
{
|
||||
"required": false,
|
||||
|
|
@ -45675,7 +45675,7 @@
|
|||
"subcategoryLabel": "Comments",
|
||||
"notes": [],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p><strong>Note:</strong> Multi-line comments on pull requests are currently in public beta and subject to change.</p>\n<p>Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.</p>\n<p><strong>Multi-line comment summary</strong></p>\n<p><strong>Note:</strong> New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the <a href=\"https://developer.github.com/changes/2019-10-03-multi-line-comments\">blog post</a> for full details.</p>\n<p>Use the <code>comfort-fade</code> preview header and the <code>line</code> parameter to show multi-line comment-supported fields in the response.</p>\n<p>If you use the <code>comfort-fade</code> preview header, your response will show:</p>\n<ul>\n<li>For multi-line comments, values for <code>start_line</code>, <code>original_start_line</code>, <code>start_side</code>, <code>line</code>, <code>original_line</code>, and <code>side</code>.</li>\n<li>For single-line comments, values for <code>line</code>, <code>original_line</code>, and <code>side</code> and a <code>null</code> value for <code>start_line</code>, <code>original_start_line</code>, and <code>start_side</code>.</li>\n</ul>\n<p>If you don't use the <code>comfort-fade</code> preview header, multi-line and single-line comments will appear the same way in the response with a single <code>position</code> attribute. Your response will show:</p>\n<ul>\n<li>For multi-line comments, the last line of the comment range for the <code>position</code> attribute.</li>\n<li>For single-line comments, the diff-positioned way of referencing comments for the <code>position</code> attribute. For more information, see <code>position</code> in the <a href=\"https://docs.github.com/enterprise-server@2.20/rest/reference/pulls#parameters-2\">input parameters</a> table.</li>\n</ul>\n<p>The <code>reactions</code> key will have the following payload where <code>url</code> can be used to construct the API location for <a href=\"https://docs.github.com/enterprise-server@2.20/rest/reference/reactions\">listing and creating</a> reactions.</p>",
|
||||
"descriptionHTML": "<p>Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.</p>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
|
|
@ -45732,7 +45732,7 @@
|
|||
}
|
||||
],
|
||||
"summary": "Get a review comment for a pull request",
|
||||
"description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nProvides details for a review comment.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/enterprise-server@2.20/rest/reference/pulls#parameters-2) table.\n\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.20/rest/reference/reactions) reactions.",
|
||||
"description": "Provides details for a review comment.",
|
||||
"tags": [
|
||||
"pulls"
|
||||
],
|
||||
|
|
@ -45748,8 +45748,8 @@
|
|||
{
|
||||
"required": false,
|
||||
"name": "comfort-fade",
|
||||
"note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.20/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```",
|
||||
"html": "<p>Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.20/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.comfort-fade-preview+json</code></pre>"
|
||||
"note": "Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for more information.\n\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.20/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```\n\nTo show multi-line comment-supported fields in the response, use the `comfort-fade` preview header and the `line` parameter.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute.",
|
||||
"html": "<p>Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the <a href=\"https://developer.github.com/changes/2019-10-03-multi-line-comments\">blog post</a> for more information.</p>\n<p>To create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.20/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.comfort-fade-preview+json</code></pre>\n<p>To show multi-line comment-supported fields in the response, use the <code>comfort-fade</code> preview header and the <code>line</code> parameter.</p>\n<p>If you use the <code>comfort-fade</code> preview header, your response will show:</p>\n<ul>\n<li>For multi-line comments, values for <code>start_line</code>, <code>original_start_line</code>, <code>start_side</code>, <code>line</code>, <code>original_line</code>, and <code>side</code>.</li>\n<li>For single-line comments, values for <code>line</code>, <code>original_line</code>, and <code>side</code> and a <code>null</code> value for <code>start_line</code>, <code>original_start_line</code>, and <code>start_side</code>.</li>\n</ul>\n<p>If you don't use the <code>comfort-fade</code> preview header, multi-line and single-line comments will appear the same way in the response with a single <code>position</code> attribute. Your response will show:</p>\n<ul>\n<li>For multi-line comments, the last line of the comment range for the <code>position</code> attribute.</li>\n<li>For single-line comments, the diff-positioned way of referencing comments for the <code>position</code> attribute.</li>\n</ul>"
|
||||
},
|
||||
{
|
||||
"required": false,
|
||||
|
|
@ -45768,7 +45768,7 @@
|
|||
"subcategoryLabel": "Comments",
|
||||
"notes": [],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p><strong>Note:</strong> Multi-line comments on pull requests are currently in public beta and subject to change.</p>\n<p>Provides details for a review comment.</p>\n<p><strong>Multi-line comment summary</strong></p>\n<p><strong>Note:</strong> New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the <a href=\"https://developer.github.com/changes/2019-10-03-multi-line-comments\">blog post</a> for full details.</p>\n<p>Use the <code>comfort-fade</code> preview header and the <code>line</code> parameter to show multi-line comment-supported fields in the response.</p>\n<p>If you use the <code>comfort-fade</code> preview header, your response will show:</p>\n<ul>\n<li>For multi-line comments, values for <code>start_line</code>, <code>original_start_line</code>, <code>start_side</code>, <code>line</code>, <code>original_line</code>, and <code>side</code>.</li>\n<li>For single-line comments, values for <code>line</code>, <code>original_line</code>, and <code>side</code> and a <code>null</code> value for <code>start_line</code>, <code>original_start_line</code>, and <code>start_side</code>.</li>\n</ul>\n<p>If you don't use the <code>comfort-fade</code> preview header, multi-line and single-line comments will appear the same way in the response with a single <code>position</code> attribute. Your response will show:</p>\n<ul>\n<li>For multi-line comments, the last line of the comment range for the <code>position</code> attribute.</li>\n<li>For single-line comments, the diff-positioned way of referencing comments for the <code>position</code> attribute. For more information, see <code>position</code> in the <a href=\"https://docs.github.com/enterprise-server@2.20/rest/reference/pulls#parameters-2\">input parameters</a> table.</li>\n</ul>\n<p>The <code>reactions</code> key will have the following payload where <code>url</code> can be used to construct the API location for <a href=\"https://docs.github.com/enterprise-server@2.20/rest/reference/reactions\">listing and creating</a> reactions.</p>",
|
||||
"descriptionHTML": "<p>Provides details for a review comment.</p>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
|
|
@ -45830,7 +45830,7 @@
|
|||
}
|
||||
],
|
||||
"summary": "Update a review comment for a pull request",
|
||||
"description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nEnables you to edit a review comment.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/enterprise-server@2.20/rest/reference/pulls#parameters-2) table.",
|
||||
"description": "Enables you to edit a review comment.",
|
||||
"tags": [
|
||||
"pulls"
|
||||
],
|
||||
|
|
@ -45872,8 +45872,8 @@
|
|||
{
|
||||
"required": false,
|
||||
"name": "comfort-fade",
|
||||
"note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.20/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```",
|
||||
"html": "<p>Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.20/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.comfort-fade-preview+json</code></pre>"
|
||||
"note": "Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for more information.\n\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.20/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```\n\nTo show multi-line comment-supported fields in the response, use the `comfort-fade` preview header and the `line` parameter.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute.",
|
||||
"html": "<p>Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the <a href=\"https://developer.github.com/changes/2019-10-03-multi-line-comments\">blog post</a> for more information.</p>\n<p>To create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.20/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.comfort-fade-preview+json</code></pre>\n<p>To show multi-line comment-supported fields in the response, use the <code>comfort-fade</code> preview header and the <code>line</code> parameter.</p>\n<p>If you use the <code>comfort-fade</code> preview header, your response will show:</p>\n<ul>\n<li>For multi-line comments, values for <code>start_line</code>, <code>original_start_line</code>, <code>start_side</code>, <code>line</code>, <code>original_line</code>, and <code>side</code>.</li>\n<li>For single-line comments, values for <code>line</code>, <code>original_line</code>, and <code>side</code> and a <code>null</code> value for <code>start_line</code>, <code>original_start_line</code>, and <code>start_side</code>.</li>\n</ul>\n<p>If you don't use the <code>comfort-fade</code> preview header, multi-line and single-line comments will appear the same way in the response with a single <code>position</code> attribute. Your response will show:</p>\n<ul>\n<li>For multi-line comments, the last line of the comment range for the <code>position</code> attribute.</li>\n<li>For single-line comments, the diff-positioned way of referencing comments for the <code>position</code> attribute.</li>\n</ul>"
|
||||
}
|
||||
],
|
||||
"category": "pulls",
|
||||
|
|
@ -45885,7 +45885,7 @@
|
|||
"subcategory": "comments",
|
||||
"subcategoryLabel": "Comments",
|
||||
"notes": [],
|
||||
"descriptionHTML": "<p><strong>Note:</strong> Multi-line comments on pull requests are currently in public beta and subject to change.</p>\n<p>Enables you to edit a review comment.</p>\n<p><strong>Multi-line comment summary</strong></p>\n<p><strong>Note:</strong> New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the <a href=\"https://developer.github.com/changes/2019-10-03-multi-line-comments\">blog post</a> for full details.</p>\n<p>Use the <code>comfort-fade</code> preview header and the <code>line</code> parameter to show multi-line comment-supported fields in the response.</p>\n<p>If you use the <code>comfort-fade</code> preview header, your response will show:</p>\n<ul>\n<li>For multi-line comments, values for <code>start_line</code>, <code>original_start_line</code>, <code>start_side</code>, <code>line</code>, <code>original_line</code>, and <code>side</code>.</li>\n<li>For single-line comments, values for <code>line</code>, <code>original_line</code>, and <code>side</code> and a <code>null</code> value for <code>start_line</code>, <code>original_start_line</code>, and <code>start_side</code>.</li>\n</ul>\n<p>If you don't use the <code>comfort-fade</code> preview header, multi-line and single-line comments will appear the same way in the response with a single <code>position</code> attribute. Your response will show:</p>\n<ul>\n<li>For multi-line comments, the last line of the comment range for the <code>position</code> attribute.</li>\n<li>For single-line comments, the diff-positioned way of referencing comments for the <code>position</code> attribute. For more information, see <code>position</code> in the <a href=\"https://docs.github.com/enterprise-server@2.20/rest/reference/pulls#parameters-2\">input parameters</a> table.</li>\n</ul>",
|
||||
"descriptionHTML": "<p>Enables you to edit a review comment.</p>",
|
||||
"bodyParameters": [
|
||||
{
|
||||
"type": "string",
|
||||
|
|
@ -46694,7 +46694,7 @@
|
|||
}
|
||||
],
|
||||
"summary": "List review comments on a pull request",
|
||||
"description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nLists all review comments for a pull request. By default, review comments are in ascending order by ID.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/enterprise-server@2.20/rest/reference/pulls#parameters-2) table.\n\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.20/rest/reference/reactions) reactions.",
|
||||
"description": "Lists all review comments for a pull request. By default, review comments are in ascending order by ID.",
|
||||
"tags": [
|
||||
"pulls"
|
||||
],
|
||||
|
|
@ -46710,8 +46710,8 @@
|
|||
{
|
||||
"required": false,
|
||||
"name": "comfort-fade",
|
||||
"note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.20/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```",
|
||||
"html": "<p>Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.20/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.comfort-fade-preview+json</code></pre>"
|
||||
"note": "Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for more information.\n\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.20/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```\n\nTo show multi-line comment-supported fields in the response, use the `comfort-fade` preview header and the `line` parameter.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute.",
|
||||
"html": "<p>Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the <a href=\"https://developer.github.com/changes/2019-10-03-multi-line-comments\">blog post</a> for more information.</p>\n<p>To create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.20/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.comfort-fade-preview+json</code></pre>\n<p>To show multi-line comment-supported fields in the response, use the <code>comfort-fade</code> preview header and the <code>line</code> parameter.</p>\n<p>If you use the <code>comfort-fade</code> preview header, your response will show:</p>\n<ul>\n<li>For multi-line comments, values for <code>start_line</code>, <code>original_start_line</code>, <code>start_side</code>, <code>line</code>, <code>original_line</code>, and <code>side</code>.</li>\n<li>For single-line comments, values for <code>line</code>, <code>original_line</code>, and <code>side</code> and a <code>null</code> value for <code>start_line</code>, <code>original_start_line</code>, and <code>start_side</code>.</li>\n</ul>\n<p>If you don't use the <code>comfort-fade</code> preview header, multi-line and single-line comments will appear the same way in the response with a single <code>position</code> attribute. Your response will show:</p>\n<ul>\n<li>For multi-line comments, the last line of the comment range for the <code>position</code> attribute.</li>\n<li>For single-line comments, the diff-positioned way of referencing comments for the <code>position</code> attribute.</li>\n</ul>"
|
||||
},
|
||||
{
|
||||
"required": false,
|
||||
|
|
@ -46730,7 +46730,7 @@
|
|||
"subcategoryLabel": "Comments",
|
||||
"notes": [],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p><strong>Note:</strong> Multi-line comments on pull requests are currently in public beta and subject to change.</p>\n<p>Lists all review comments for a pull request. By default, review comments are in ascending order by ID.</p>\n<p><strong>Multi-line comment summary</strong></p>\n<p><strong>Note:</strong> New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the <a href=\"https://developer.github.com/changes/2019-10-03-multi-line-comments\">blog post</a> for full details.</p>\n<p>Use the <code>comfort-fade</code> preview header and the <code>line</code> parameter to show multi-line comment-supported fields in the response.</p>\n<p>If you use the <code>comfort-fade</code> preview header, your response will show:</p>\n<ul>\n<li>For multi-line comments, values for <code>start_line</code>, <code>original_start_line</code>, <code>start_side</code>, <code>line</code>, <code>original_line</code>, and <code>side</code>.</li>\n<li>For single-line comments, values for <code>line</code>, <code>original_line</code>, and <code>side</code> and a <code>null</code> value for <code>start_line</code>, <code>original_start_line</code>, and <code>start_side</code>.</li>\n</ul>\n<p>If you don't use the <code>comfort-fade</code> preview header, multi-line and single-line comments will appear the same way in the response with a single <code>position</code> attribute. Your response will show:</p>\n<ul>\n<li>For multi-line comments, the last line of the comment range for the <code>position</code> attribute.</li>\n<li>For single-line comments, the diff-positioned way of referencing comments for the <code>position</code> attribute. For more information, see <code>position</code> in the <a href=\"https://docs.github.com/enterprise-server@2.20/rest/reference/pulls#parameters-2\">input parameters</a> table.</li>\n</ul>\n<p>The <code>reactions</code> key will have the following payload where <code>url</code> can be used to construct the API location for <a href=\"https://docs.github.com/enterprise-server@2.20/rest/reference/reactions\">listing and creating</a> reactions.</p>",
|
||||
"descriptionHTML": "<p>Lists all review comments for a pull request. By default, review comments are in ascending order by ID.</p>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
|
|
@ -46786,7 +46786,7 @@
|
|||
}
|
||||
],
|
||||
"summary": "Create a review comment for a pull request",
|
||||
"description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nCreates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"[Create an issue comment](https://docs.github.com/enterprise-server@2.20/rest/reference/issues#create-an-issue-comment).\" We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff.\n\nYou can still create a review comment using the `position` parameter. When you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. For more information, see [Multi-line comment summary](https://docs.github.com/enterprise-server@2.20/rest/reference/pulls#multi-line-comment-summary-3).\n\n**Note:** The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.20/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.20/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/enterprise-server@2.20/rest/reference/pulls#parameters-2) table.",
|
||||
"description": "\nCreates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"[Create an issue comment](https://docs.github.com/enterprise-server@2.20/rest/reference/issues#create-an-issue-comment).\" We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff.\n\nYou can still create a review comment using the `position` parameter. When you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. For more information, see the [`comfort-fade` preview notice](https://docs.github.com/enterprise-server@2.20/rest/reference/pulls#create-a-review-comment-for-a-pull-request-preview-notices).\n\n**Note:** The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.20/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.20/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.",
|
||||
"tags": [
|
||||
"pulls"
|
||||
],
|
||||
|
|
@ -46932,8 +46932,8 @@
|
|||
{
|
||||
"required": false,
|
||||
"name": "comfort-fade",
|
||||
"note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.20/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```",
|
||||
"html": "<p>Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.20/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.comfort-fade-preview+json</code></pre>"
|
||||
"note": "Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for more information.\n\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.20/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```\n\nTo show multi-line comment-supported fields in the response, use the `comfort-fade` preview header and the `line` parameter.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute.",
|
||||
"html": "<p>Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the <a href=\"https://developer.github.com/changes/2019-10-03-multi-line-comments\">blog post</a> for more information.</p>\n<p>To create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.20/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.comfort-fade-preview+json</code></pre>\n<p>To show multi-line comment-supported fields in the response, use the <code>comfort-fade</code> preview header and the <code>line</code> parameter.</p>\n<p>If you use the <code>comfort-fade</code> preview header, your response will show:</p>\n<ul>\n<li>For multi-line comments, values for <code>start_line</code>, <code>original_start_line</code>, <code>start_side</code>, <code>line</code>, <code>original_line</code>, and <code>side</code>.</li>\n<li>For single-line comments, values for <code>line</code>, <code>original_line</code>, and <code>side</code> and a <code>null</code> value for <code>start_line</code>, <code>original_start_line</code>, and <code>start_side</code>.</li>\n</ul>\n<p>If you don't use the <code>comfort-fade</code> preview header, multi-line and single-line comments will appear the same way in the response with a single <code>position</code> attribute. Your response will show:</p>\n<ul>\n<li>For multi-line comments, the last line of the comment range for the <code>position</code> attribute.</li>\n<li>For single-line comments, the diff-positioned way of referencing comments for the <code>position</code> attribute.</li>\n</ul>"
|
||||
}
|
||||
],
|
||||
"category": "pulls",
|
||||
|
|
@ -46945,7 +46945,7 @@
|
|||
"subcategory": "comments",
|
||||
"subcategoryLabel": "Comments",
|
||||
"notes": [],
|
||||
"descriptionHTML": "<p><strong>Note:</strong> Multi-line comments on pull requests are currently in public beta and subject to change.</p>\n<p>Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"<a href=\"https://docs.github.com/enterprise-server@2.20/rest/reference/issues#create-an-issue-comment\">Create an issue comment</a>.\" We recommend creating a review comment using <code>line</code>, <code>side</code>, and optionally <code>start_line</code> and <code>start_side</code> if your comment applies to more than one line in the pull request diff.</p>\n<p>You can still create a review comment using the <code>position</code> parameter. When you use <code>position</code>, the <code>line</code>, <code>side</code>, <code>start_line</code>, and <code>start_side</code> parameters are not required. For more information, see <a href=\"https://docs.github.com/enterprise-server@2.20/rest/reference/pulls#multi-line-comment-summary-3\">Multi-line comment summary</a>.</p>\n<p><strong>Note:</strong> The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.</p>\n<p>This endpoint triggers <a href=\"https://help.github.com/articles/about-notifications/\">notifications</a>. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"<a href=\"https://docs.github.com/enterprise-server@2.20/rest/overview/resources-in-the-rest-api#abuse-rate-limits\">Abuse rate limits</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@2.20/rest/guides/best-practices-for-integrators#dealing-with-rate-limits\">Dealing with abuse rate limits</a>\" for details.</p>\n<p><strong>Multi-line comment summary</strong></p>\n<p><strong>Note:</strong> New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the <a href=\"https://developer.github.com/changes/2019-10-03-multi-line-comments\">blog post</a> for full details.</p>\n<p>Use the <code>comfort-fade</code> preview header and the <code>line</code> parameter to show multi-line comment-supported fields in the response.</p>\n<p>If you use the <code>comfort-fade</code> preview header, your response will show:</p>\n<ul>\n<li>For multi-line comments, values for <code>start_line</code>, <code>original_start_line</code>, <code>start_side</code>, <code>line</code>, <code>original_line</code>, and <code>side</code>.</li>\n<li>For single-line comments, values for <code>line</code>, <code>original_line</code>, and <code>side</code> and a <code>null</code> value for <code>start_line</code>, <code>original_start_line</code>, and <code>start_side</code>.</li>\n</ul>\n<p>If you don't use the <code>comfort-fade</code> preview header, multi-line and single-line comments will appear the same way in the response with a single <code>position</code> attribute. Your response will show:</p>\n<ul>\n<li>For multi-line comments, the last line of the comment range for the <code>position</code> attribute.</li>\n<li>For single-line comments, the diff-positioned way of referencing comments for the <code>position</code> attribute. For more information, see <code>position</code> in the <a href=\"https://docs.github.com/enterprise-server@2.20/rest/reference/pulls#parameters-2\">input parameters</a> table.</li>\n</ul>",
|
||||
"descriptionHTML": "<p>Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"<a href=\"https://docs.github.com/enterprise-server@2.20/rest/reference/issues#create-an-issue-comment\">Create an issue comment</a>.\" We recommend creating a review comment using <code>line</code>, <code>side</code>, and optionally <code>start_line</code> and <code>start_side</code> if your comment applies to more than one line in the pull request diff.</p>\n<p>You can still create a review comment using the <code>position</code> parameter. When you use <code>position</code>, the <code>line</code>, <code>side</code>, <code>start_line</code>, and <code>start_side</code> parameters are not required. For more information, see the <a href=\"https://docs.github.com/enterprise-server@2.20/rest/reference/pulls#create-a-review-comment-for-a-pull-request-preview-notices\"><code>comfort-fade</code> preview notice</a>.</p>\n<p><strong>Note:</strong> The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.</p>\n<p>This endpoint triggers <a href=\"https://help.github.com/articles/about-notifications/\">notifications</a>. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"<a href=\"https://docs.github.com/enterprise-server@2.20/rest/overview/resources-in-the-rest-api#abuse-rate-limits\">Abuse rate limits</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@2.20/rest/guides/best-practices-for-integrators#dealing-with-rate-limits\">Dealing with abuse rate limits</a>\" for details.</p>",
|
||||
"bodyParameters": [
|
||||
{
|
||||
"type": "string",
|
||||
|
|
@ -61244,11 +61244,6 @@
|
|||
"httpStatusMessage": "Forbidden",
|
||||
"description": "Forbidden"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "418",
|
||||
"httpStatusMessage": "I'm A Teapot",
|
||||
"description": "Response definition missing"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "422",
|
||||
"httpStatusMessage": "Unprocessable Entity",
|
||||
|
|
|
|||
|
|
@ -49462,7 +49462,7 @@
|
|||
}
|
||||
],
|
||||
"summary": "List review comments in a repository",
|
||||
"description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nLists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/enterprise-server@2.21/rest/reference/pulls#parameters-2) table.\n\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.21/rest/reference/reactions) reactions.",
|
||||
"description": "Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.",
|
||||
"tags": [
|
||||
"pulls"
|
||||
],
|
||||
|
|
@ -49478,8 +49478,8 @@
|
|||
{
|
||||
"required": false,
|
||||
"name": "comfort-fade",
|
||||
"note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.21/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```",
|
||||
"html": "<p>Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.21/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.comfort-fade-preview+json</code></pre>"
|
||||
"note": "Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for more information.\n\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.21/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```\n\nTo show multi-line comment-supported fields in the response, use the `comfort-fade` preview header and the `line` parameter.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute.",
|
||||
"html": "<p>Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the <a href=\"https://developer.github.com/changes/2019-10-03-multi-line-comments\">blog post</a> for more information.</p>\n<p>To create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.21/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.comfort-fade-preview+json</code></pre>\n<p>To show multi-line comment-supported fields in the response, use the <code>comfort-fade</code> preview header and the <code>line</code> parameter.</p>\n<p>If you use the <code>comfort-fade</code> preview header, your response will show:</p>\n<ul>\n<li>For multi-line comments, values for <code>start_line</code>, <code>original_start_line</code>, <code>start_side</code>, <code>line</code>, <code>original_line</code>, and <code>side</code>.</li>\n<li>For single-line comments, values for <code>line</code>, <code>original_line</code>, and <code>side</code> and a <code>null</code> value for <code>start_line</code>, <code>original_start_line</code>, and <code>start_side</code>.</li>\n</ul>\n<p>If you don't use the <code>comfort-fade</code> preview header, multi-line and single-line comments will appear the same way in the response with a single <code>position</code> attribute. Your response will show:</p>\n<ul>\n<li>For multi-line comments, the last line of the comment range for the <code>position</code> attribute.</li>\n<li>For single-line comments, the diff-positioned way of referencing comments for the <code>position</code> attribute.</li>\n</ul>"
|
||||
},
|
||||
{
|
||||
"required": false,
|
||||
|
|
@ -49498,7 +49498,7 @@
|
|||
"subcategoryLabel": "Comments",
|
||||
"notes": [],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p><strong>Note:</strong> Multi-line comments on pull requests are currently in public beta and subject to change.</p>\n<p>Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.</p>\n<p><strong>Multi-line comment summary</strong></p>\n<p><strong>Note:</strong> New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the <a href=\"https://developer.github.com/changes/2019-10-03-multi-line-comments\">blog post</a> for full details.</p>\n<p>Use the <code>comfort-fade</code> preview header and the <code>line</code> parameter to show multi-line comment-supported fields in the response.</p>\n<p>If you use the <code>comfort-fade</code> preview header, your response will show:</p>\n<ul>\n<li>For multi-line comments, values for <code>start_line</code>, <code>original_start_line</code>, <code>start_side</code>, <code>line</code>, <code>original_line</code>, and <code>side</code>.</li>\n<li>For single-line comments, values for <code>line</code>, <code>original_line</code>, and <code>side</code> and a <code>null</code> value for <code>start_line</code>, <code>original_start_line</code>, and <code>start_side</code>.</li>\n</ul>\n<p>If you don't use the <code>comfort-fade</code> preview header, multi-line and single-line comments will appear the same way in the response with a single <code>position</code> attribute. Your response will show:</p>\n<ul>\n<li>For multi-line comments, the last line of the comment range for the <code>position</code> attribute.</li>\n<li>For single-line comments, the diff-positioned way of referencing comments for the <code>position</code> attribute. For more information, see <code>position</code> in the <a href=\"https://docs.github.com/enterprise-server@2.21/rest/reference/pulls#parameters-2\">input parameters</a> table.</li>\n</ul>\n<p>The <code>reactions</code> key will have the following payload where <code>url</code> can be used to construct the API location for <a href=\"https://docs.github.com/enterprise-server@2.21/rest/reference/reactions\">listing and creating</a> reactions.</p>",
|
||||
"descriptionHTML": "<p>Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.</p>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
|
|
@ -49555,7 +49555,7 @@
|
|||
}
|
||||
],
|
||||
"summary": "Get a review comment for a pull request",
|
||||
"description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nProvides details for a review comment.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/enterprise-server@2.21/rest/reference/pulls#parameters-2) table.\n\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.21/rest/reference/reactions) reactions.",
|
||||
"description": "Provides details for a review comment.",
|
||||
"tags": [
|
||||
"pulls"
|
||||
],
|
||||
|
|
@ -49571,8 +49571,8 @@
|
|||
{
|
||||
"required": false,
|
||||
"name": "comfort-fade",
|
||||
"note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.21/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```",
|
||||
"html": "<p>Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.21/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.comfort-fade-preview+json</code></pre>"
|
||||
"note": "Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for more information.\n\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.21/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```\n\nTo show multi-line comment-supported fields in the response, use the `comfort-fade` preview header and the `line` parameter.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute.",
|
||||
"html": "<p>Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the <a href=\"https://developer.github.com/changes/2019-10-03-multi-line-comments\">blog post</a> for more information.</p>\n<p>To create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.21/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.comfort-fade-preview+json</code></pre>\n<p>To show multi-line comment-supported fields in the response, use the <code>comfort-fade</code> preview header and the <code>line</code> parameter.</p>\n<p>If you use the <code>comfort-fade</code> preview header, your response will show:</p>\n<ul>\n<li>For multi-line comments, values for <code>start_line</code>, <code>original_start_line</code>, <code>start_side</code>, <code>line</code>, <code>original_line</code>, and <code>side</code>.</li>\n<li>For single-line comments, values for <code>line</code>, <code>original_line</code>, and <code>side</code> and a <code>null</code> value for <code>start_line</code>, <code>original_start_line</code>, and <code>start_side</code>.</li>\n</ul>\n<p>If you don't use the <code>comfort-fade</code> preview header, multi-line and single-line comments will appear the same way in the response with a single <code>position</code> attribute. Your response will show:</p>\n<ul>\n<li>For multi-line comments, the last line of the comment range for the <code>position</code> attribute.</li>\n<li>For single-line comments, the diff-positioned way of referencing comments for the <code>position</code> attribute.</li>\n</ul>"
|
||||
},
|
||||
{
|
||||
"required": false,
|
||||
|
|
@ -49591,7 +49591,7 @@
|
|||
"subcategoryLabel": "Comments",
|
||||
"notes": [],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p><strong>Note:</strong> Multi-line comments on pull requests are currently in public beta and subject to change.</p>\n<p>Provides details for a review comment.</p>\n<p><strong>Multi-line comment summary</strong></p>\n<p><strong>Note:</strong> New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the <a href=\"https://developer.github.com/changes/2019-10-03-multi-line-comments\">blog post</a> for full details.</p>\n<p>Use the <code>comfort-fade</code> preview header and the <code>line</code> parameter to show multi-line comment-supported fields in the response.</p>\n<p>If you use the <code>comfort-fade</code> preview header, your response will show:</p>\n<ul>\n<li>For multi-line comments, values for <code>start_line</code>, <code>original_start_line</code>, <code>start_side</code>, <code>line</code>, <code>original_line</code>, and <code>side</code>.</li>\n<li>For single-line comments, values for <code>line</code>, <code>original_line</code>, and <code>side</code> and a <code>null</code> value for <code>start_line</code>, <code>original_start_line</code>, and <code>start_side</code>.</li>\n</ul>\n<p>If you don't use the <code>comfort-fade</code> preview header, multi-line and single-line comments will appear the same way in the response with a single <code>position</code> attribute. Your response will show:</p>\n<ul>\n<li>For multi-line comments, the last line of the comment range for the <code>position</code> attribute.</li>\n<li>For single-line comments, the diff-positioned way of referencing comments for the <code>position</code> attribute. For more information, see <code>position</code> in the <a href=\"https://docs.github.com/enterprise-server@2.21/rest/reference/pulls#parameters-2\">input parameters</a> table.</li>\n</ul>\n<p>The <code>reactions</code> key will have the following payload where <code>url</code> can be used to construct the API location for <a href=\"https://docs.github.com/enterprise-server@2.21/rest/reference/reactions\">listing and creating</a> reactions.</p>",
|
||||
"descriptionHTML": "<p>Provides details for a review comment.</p>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
|
|
@ -49653,7 +49653,7 @@
|
|||
}
|
||||
],
|
||||
"summary": "Update a review comment for a pull request",
|
||||
"description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nEnables you to edit a review comment.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/enterprise-server@2.21/rest/reference/pulls#parameters-2) table.",
|
||||
"description": "Enables you to edit a review comment.",
|
||||
"tags": [
|
||||
"pulls"
|
||||
],
|
||||
|
|
@ -49695,8 +49695,8 @@
|
|||
{
|
||||
"required": false,
|
||||
"name": "comfort-fade",
|
||||
"note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.21/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```",
|
||||
"html": "<p>Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.21/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.comfort-fade-preview+json</code></pre>"
|
||||
"note": "Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for more information.\n\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.21/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```\n\nTo show multi-line comment-supported fields in the response, use the `comfort-fade` preview header and the `line` parameter.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute.",
|
||||
"html": "<p>Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the <a href=\"https://developer.github.com/changes/2019-10-03-multi-line-comments\">blog post</a> for more information.</p>\n<p>To create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.21/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.comfort-fade-preview+json</code></pre>\n<p>To show multi-line comment-supported fields in the response, use the <code>comfort-fade</code> preview header and the <code>line</code> parameter.</p>\n<p>If you use the <code>comfort-fade</code> preview header, your response will show:</p>\n<ul>\n<li>For multi-line comments, values for <code>start_line</code>, <code>original_start_line</code>, <code>start_side</code>, <code>line</code>, <code>original_line</code>, and <code>side</code>.</li>\n<li>For single-line comments, values for <code>line</code>, <code>original_line</code>, and <code>side</code> and a <code>null</code> value for <code>start_line</code>, <code>original_start_line</code>, and <code>start_side</code>.</li>\n</ul>\n<p>If you don't use the <code>comfort-fade</code> preview header, multi-line and single-line comments will appear the same way in the response with a single <code>position</code> attribute. Your response will show:</p>\n<ul>\n<li>For multi-line comments, the last line of the comment range for the <code>position</code> attribute.</li>\n<li>For single-line comments, the diff-positioned way of referencing comments for the <code>position</code> attribute.</li>\n</ul>"
|
||||
}
|
||||
],
|
||||
"category": "pulls",
|
||||
|
|
@ -49708,7 +49708,7 @@
|
|||
"subcategory": "comments",
|
||||
"subcategoryLabel": "Comments",
|
||||
"notes": [],
|
||||
"descriptionHTML": "<p><strong>Note:</strong> Multi-line comments on pull requests are currently in public beta and subject to change.</p>\n<p>Enables you to edit a review comment.</p>\n<p><strong>Multi-line comment summary</strong></p>\n<p><strong>Note:</strong> New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the <a href=\"https://developer.github.com/changes/2019-10-03-multi-line-comments\">blog post</a> for full details.</p>\n<p>Use the <code>comfort-fade</code> preview header and the <code>line</code> parameter to show multi-line comment-supported fields in the response.</p>\n<p>If you use the <code>comfort-fade</code> preview header, your response will show:</p>\n<ul>\n<li>For multi-line comments, values for <code>start_line</code>, <code>original_start_line</code>, <code>start_side</code>, <code>line</code>, <code>original_line</code>, and <code>side</code>.</li>\n<li>For single-line comments, values for <code>line</code>, <code>original_line</code>, and <code>side</code> and a <code>null</code> value for <code>start_line</code>, <code>original_start_line</code>, and <code>start_side</code>.</li>\n</ul>\n<p>If you don't use the <code>comfort-fade</code> preview header, multi-line and single-line comments will appear the same way in the response with a single <code>position</code> attribute. Your response will show:</p>\n<ul>\n<li>For multi-line comments, the last line of the comment range for the <code>position</code> attribute.</li>\n<li>For single-line comments, the diff-positioned way of referencing comments for the <code>position</code> attribute. For more information, see <code>position</code> in the <a href=\"https://docs.github.com/enterprise-server@2.21/rest/reference/pulls#parameters-2\">input parameters</a> table.</li>\n</ul>",
|
||||
"descriptionHTML": "<p>Enables you to edit a review comment.</p>",
|
||||
"bodyParameters": [
|
||||
{
|
||||
"type": "string",
|
||||
|
|
@ -50604,7 +50604,7 @@
|
|||
}
|
||||
],
|
||||
"summary": "List review comments on a pull request",
|
||||
"description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nLists all review comments for a pull request. By default, review comments are in ascending order by ID.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/enterprise-server@2.21/rest/reference/pulls#parameters-2) table.\n\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.21/rest/reference/reactions) reactions.",
|
||||
"description": "Lists all review comments for a pull request. By default, review comments are in ascending order by ID.",
|
||||
"tags": [
|
||||
"pulls"
|
||||
],
|
||||
|
|
@ -50620,8 +50620,8 @@
|
|||
{
|
||||
"required": false,
|
||||
"name": "comfort-fade",
|
||||
"note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.21/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```",
|
||||
"html": "<p>Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.21/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.comfort-fade-preview+json</code></pre>"
|
||||
"note": "Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for more information.\n\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.21/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```\n\nTo show multi-line comment-supported fields in the response, use the `comfort-fade` preview header and the `line` parameter.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute.",
|
||||
"html": "<p>Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the <a href=\"https://developer.github.com/changes/2019-10-03-multi-line-comments\">blog post</a> for more information.</p>\n<p>To create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.21/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.comfort-fade-preview+json</code></pre>\n<p>To show multi-line comment-supported fields in the response, use the <code>comfort-fade</code> preview header and the <code>line</code> parameter.</p>\n<p>If you use the <code>comfort-fade</code> preview header, your response will show:</p>\n<ul>\n<li>For multi-line comments, values for <code>start_line</code>, <code>original_start_line</code>, <code>start_side</code>, <code>line</code>, <code>original_line</code>, and <code>side</code>.</li>\n<li>For single-line comments, values for <code>line</code>, <code>original_line</code>, and <code>side</code> and a <code>null</code> value for <code>start_line</code>, <code>original_start_line</code>, and <code>start_side</code>.</li>\n</ul>\n<p>If you don't use the <code>comfort-fade</code> preview header, multi-line and single-line comments will appear the same way in the response with a single <code>position</code> attribute. Your response will show:</p>\n<ul>\n<li>For multi-line comments, the last line of the comment range for the <code>position</code> attribute.</li>\n<li>For single-line comments, the diff-positioned way of referencing comments for the <code>position</code> attribute.</li>\n</ul>"
|
||||
},
|
||||
{
|
||||
"required": false,
|
||||
|
|
@ -50640,7 +50640,7 @@
|
|||
"subcategoryLabel": "Comments",
|
||||
"notes": [],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p><strong>Note:</strong> Multi-line comments on pull requests are currently in public beta and subject to change.</p>\n<p>Lists all review comments for a pull request. By default, review comments are in ascending order by ID.</p>\n<p><strong>Multi-line comment summary</strong></p>\n<p><strong>Note:</strong> New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the <a href=\"https://developer.github.com/changes/2019-10-03-multi-line-comments\">blog post</a> for full details.</p>\n<p>Use the <code>comfort-fade</code> preview header and the <code>line</code> parameter to show multi-line comment-supported fields in the response.</p>\n<p>If you use the <code>comfort-fade</code> preview header, your response will show:</p>\n<ul>\n<li>For multi-line comments, values for <code>start_line</code>, <code>original_start_line</code>, <code>start_side</code>, <code>line</code>, <code>original_line</code>, and <code>side</code>.</li>\n<li>For single-line comments, values for <code>line</code>, <code>original_line</code>, and <code>side</code> and a <code>null</code> value for <code>start_line</code>, <code>original_start_line</code>, and <code>start_side</code>.</li>\n</ul>\n<p>If you don't use the <code>comfort-fade</code> preview header, multi-line and single-line comments will appear the same way in the response with a single <code>position</code> attribute. Your response will show:</p>\n<ul>\n<li>For multi-line comments, the last line of the comment range for the <code>position</code> attribute.</li>\n<li>For single-line comments, the diff-positioned way of referencing comments for the <code>position</code> attribute. For more information, see <code>position</code> in the <a href=\"https://docs.github.com/enterprise-server@2.21/rest/reference/pulls#parameters-2\">input parameters</a> table.</li>\n</ul>\n<p>The <code>reactions</code> key will have the following payload where <code>url</code> can be used to construct the API location for <a href=\"https://docs.github.com/enterprise-server@2.21/rest/reference/reactions\">listing and creating</a> reactions.</p>",
|
||||
"descriptionHTML": "<p>Lists all review comments for a pull request. By default, review comments are in ascending order by ID.</p>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
|
|
@ -50696,7 +50696,7 @@
|
|||
}
|
||||
],
|
||||
"summary": "Create a review comment for a pull request",
|
||||
"description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nCreates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"[Create an issue comment](https://docs.github.com/enterprise-server@2.21/rest/reference/issues#create-an-issue-comment).\" We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff.\n\nYou can still create a review comment using the `position` parameter. When you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. For more information, see [Multi-line comment summary](https://docs.github.com/enterprise-server@2.21/rest/reference/pulls#multi-line-comment-summary-3).\n\n**Note:** The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.21/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.21/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/enterprise-server@2.21/rest/reference/pulls#parameters-2) table.",
|
||||
"description": "\nCreates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"[Create an issue comment](https://docs.github.com/enterprise-server@2.21/rest/reference/issues#create-an-issue-comment).\" We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff.\n\nYou can still create a review comment using the `position` parameter. When you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. For more information, see the [`comfort-fade` preview notice](https://docs.github.com/enterprise-server@2.21/rest/reference/pulls#create-a-review-comment-for-a-pull-request-preview-notices).\n\n**Note:** The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.21/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.21/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.",
|
||||
"tags": [
|
||||
"pulls"
|
||||
],
|
||||
|
|
@ -50842,8 +50842,8 @@
|
|||
{
|
||||
"required": false,
|
||||
"name": "comfort-fade",
|
||||
"note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.21/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```",
|
||||
"html": "<p>Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.21/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.comfort-fade-preview+json</code></pre>"
|
||||
"note": "Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for more information.\n\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.21/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```\n\nTo show multi-line comment-supported fields in the response, use the `comfort-fade` preview header and the `line` parameter.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute.",
|
||||
"html": "<p>Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the <a href=\"https://developer.github.com/changes/2019-10-03-multi-line-comments\">blog post</a> for more information.</p>\n<p>To create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.21/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.comfort-fade-preview+json</code></pre>\n<p>To show multi-line comment-supported fields in the response, use the <code>comfort-fade</code> preview header and the <code>line</code> parameter.</p>\n<p>If you use the <code>comfort-fade</code> preview header, your response will show:</p>\n<ul>\n<li>For multi-line comments, values for <code>start_line</code>, <code>original_start_line</code>, <code>start_side</code>, <code>line</code>, <code>original_line</code>, and <code>side</code>.</li>\n<li>For single-line comments, values for <code>line</code>, <code>original_line</code>, and <code>side</code> and a <code>null</code> value for <code>start_line</code>, <code>original_start_line</code>, and <code>start_side</code>.</li>\n</ul>\n<p>If you don't use the <code>comfort-fade</code> preview header, multi-line and single-line comments will appear the same way in the response with a single <code>position</code> attribute. Your response will show:</p>\n<ul>\n<li>For multi-line comments, the last line of the comment range for the <code>position</code> attribute.</li>\n<li>For single-line comments, the diff-positioned way of referencing comments for the <code>position</code> attribute.</li>\n</ul>"
|
||||
}
|
||||
],
|
||||
"category": "pulls",
|
||||
|
|
@ -50855,7 +50855,7 @@
|
|||
"subcategory": "comments",
|
||||
"subcategoryLabel": "Comments",
|
||||
"notes": [],
|
||||
"descriptionHTML": "<p><strong>Note:</strong> Multi-line comments on pull requests are currently in public beta and subject to change.</p>\n<p>Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"<a href=\"https://docs.github.com/enterprise-server@2.21/rest/reference/issues#create-an-issue-comment\">Create an issue comment</a>.\" We recommend creating a review comment using <code>line</code>, <code>side</code>, and optionally <code>start_line</code> and <code>start_side</code> if your comment applies to more than one line in the pull request diff.</p>\n<p>You can still create a review comment using the <code>position</code> parameter. When you use <code>position</code>, the <code>line</code>, <code>side</code>, <code>start_line</code>, and <code>start_side</code> parameters are not required. For more information, see <a href=\"https://docs.github.com/enterprise-server@2.21/rest/reference/pulls#multi-line-comment-summary-3\">Multi-line comment summary</a>.</p>\n<p><strong>Note:</strong> The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.</p>\n<p>This endpoint triggers <a href=\"https://help.github.com/articles/about-notifications/\">notifications</a>. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"<a href=\"https://docs.github.com/enterprise-server@2.21/rest/overview/resources-in-the-rest-api#abuse-rate-limits\">Abuse rate limits</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@2.21/rest/guides/best-practices-for-integrators#dealing-with-rate-limits\">Dealing with abuse rate limits</a>\" for details.</p>\n<p><strong>Multi-line comment summary</strong></p>\n<p><strong>Note:</strong> New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the <a href=\"https://developer.github.com/changes/2019-10-03-multi-line-comments\">blog post</a> for full details.</p>\n<p>Use the <code>comfort-fade</code> preview header and the <code>line</code> parameter to show multi-line comment-supported fields in the response.</p>\n<p>If you use the <code>comfort-fade</code> preview header, your response will show:</p>\n<ul>\n<li>For multi-line comments, values for <code>start_line</code>, <code>original_start_line</code>, <code>start_side</code>, <code>line</code>, <code>original_line</code>, and <code>side</code>.</li>\n<li>For single-line comments, values for <code>line</code>, <code>original_line</code>, and <code>side</code> and a <code>null</code> value for <code>start_line</code>, <code>original_start_line</code>, and <code>start_side</code>.</li>\n</ul>\n<p>If you don't use the <code>comfort-fade</code> preview header, multi-line and single-line comments will appear the same way in the response with a single <code>position</code> attribute. Your response will show:</p>\n<ul>\n<li>For multi-line comments, the last line of the comment range for the <code>position</code> attribute.</li>\n<li>For single-line comments, the diff-positioned way of referencing comments for the <code>position</code> attribute. For more information, see <code>position</code> in the <a href=\"https://docs.github.com/enterprise-server@2.21/rest/reference/pulls#parameters-2\">input parameters</a> table.</li>\n</ul>",
|
||||
"descriptionHTML": "<p>Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"<a href=\"https://docs.github.com/enterprise-server@2.21/rest/reference/issues#create-an-issue-comment\">Create an issue comment</a>.\" We recommend creating a review comment using <code>line</code>, <code>side</code>, and optionally <code>start_line</code> and <code>start_side</code> if your comment applies to more than one line in the pull request diff.</p>\n<p>You can still create a review comment using the <code>position</code> parameter. When you use <code>position</code>, the <code>line</code>, <code>side</code>, <code>start_line</code>, and <code>start_side</code> parameters are not required. For more information, see the <a href=\"https://docs.github.com/enterprise-server@2.21/rest/reference/pulls#create-a-review-comment-for-a-pull-request-preview-notices\"><code>comfort-fade</code> preview notice</a>.</p>\n<p><strong>Note:</strong> The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.</p>\n<p>This endpoint triggers <a href=\"https://help.github.com/articles/about-notifications/\">notifications</a>. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"<a href=\"https://docs.github.com/enterprise-server@2.21/rest/overview/resources-in-the-rest-api#abuse-rate-limits\">Abuse rate limits</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@2.21/rest/guides/best-practices-for-integrators#dealing-with-rate-limits\">Dealing with abuse rate limits</a>\" for details.</p>",
|
||||
"bodyParameters": [
|
||||
{
|
||||
"type": "string",
|
||||
|
|
@ -65328,11 +65328,6 @@
|
|||
"httpStatusMessage": "Forbidden",
|
||||
"description": "Forbidden"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "418",
|
||||
"httpStatusMessage": "I'm A Teapot",
|
||||
"description": "Response definition missing"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "422",
|
||||
"httpStatusMessage": "Unprocessable Entity",
|
||||
|
|
|
|||
|
|
@ -56879,7 +56879,7 @@
|
|||
}
|
||||
],
|
||||
"summary": "List review comments in a repository",
|
||||
"description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nLists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/enterprise-server@2.22/rest/reference/pulls#parameters-2) table.\n\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.22/rest/reference/reactions) reactions.",
|
||||
"description": "Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.",
|
||||
"tags": [
|
||||
"pulls"
|
||||
],
|
||||
|
|
@ -56895,8 +56895,8 @@
|
|||
{
|
||||
"required": false,
|
||||
"name": "comfort-fade",
|
||||
"note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.22/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```",
|
||||
"html": "<p>Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.22/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.comfort-fade-preview+json</code></pre>"
|
||||
"note": "Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for more information.\n\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.22/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```\n\nTo show multi-line comment-supported fields in the response, use the `comfort-fade` preview header and the `line` parameter.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute.",
|
||||
"html": "<p>Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the <a href=\"https://developer.github.com/changes/2019-10-03-multi-line-comments\">blog post</a> for more information.</p>\n<p>To create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.22/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.comfort-fade-preview+json</code></pre>\n<p>To show multi-line comment-supported fields in the response, use the <code>comfort-fade</code> preview header and the <code>line</code> parameter.</p>\n<p>If you use the <code>comfort-fade</code> preview header, your response will show:</p>\n<ul>\n<li>For multi-line comments, values for <code>start_line</code>, <code>original_start_line</code>, <code>start_side</code>, <code>line</code>, <code>original_line</code>, and <code>side</code>.</li>\n<li>For single-line comments, values for <code>line</code>, <code>original_line</code>, and <code>side</code> and a <code>null</code> value for <code>start_line</code>, <code>original_start_line</code>, and <code>start_side</code>.</li>\n</ul>\n<p>If you don't use the <code>comfort-fade</code> preview header, multi-line and single-line comments will appear the same way in the response with a single <code>position</code> attribute. Your response will show:</p>\n<ul>\n<li>For multi-line comments, the last line of the comment range for the <code>position</code> attribute.</li>\n<li>For single-line comments, the diff-positioned way of referencing comments for the <code>position</code> attribute.</li>\n</ul>"
|
||||
},
|
||||
{
|
||||
"required": false,
|
||||
|
|
@ -56915,7 +56915,7 @@
|
|||
"subcategoryLabel": "Comments",
|
||||
"notes": [],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p><strong>Note:</strong> Multi-line comments on pull requests are currently in public beta and subject to change.</p>\n<p>Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.</p>\n<p><strong>Multi-line comment summary</strong></p>\n<p><strong>Note:</strong> New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the <a href=\"https://developer.github.com/changes/2019-10-03-multi-line-comments\">blog post</a> for full details.</p>\n<p>Use the <code>comfort-fade</code> preview header and the <code>line</code> parameter to show multi-line comment-supported fields in the response.</p>\n<p>If you use the <code>comfort-fade</code> preview header, your response will show:</p>\n<ul>\n<li>For multi-line comments, values for <code>start_line</code>, <code>original_start_line</code>, <code>start_side</code>, <code>line</code>, <code>original_line</code>, and <code>side</code>.</li>\n<li>For single-line comments, values for <code>line</code>, <code>original_line</code>, and <code>side</code> and a <code>null</code> value for <code>start_line</code>, <code>original_start_line</code>, and <code>start_side</code>.</li>\n</ul>\n<p>If you don't use the <code>comfort-fade</code> preview header, multi-line and single-line comments will appear the same way in the response with a single <code>position</code> attribute. Your response will show:</p>\n<ul>\n<li>For multi-line comments, the last line of the comment range for the <code>position</code> attribute.</li>\n<li>For single-line comments, the diff-positioned way of referencing comments for the <code>position</code> attribute. For more information, see <code>position</code> in the <a href=\"https://docs.github.com/enterprise-server@2.22/rest/reference/pulls#parameters-2\">input parameters</a> table.</li>\n</ul>\n<p>The <code>reactions</code> key will have the following payload where <code>url</code> can be used to construct the API location for <a href=\"https://docs.github.com/enterprise-server@2.22/rest/reference/reactions\">listing and creating</a> reactions.</p>",
|
||||
"descriptionHTML": "<p>Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.</p>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
|
|
@ -56972,7 +56972,7 @@
|
|||
}
|
||||
],
|
||||
"summary": "Get a review comment for a pull request",
|
||||
"description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nProvides details for a review comment.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/enterprise-server@2.22/rest/reference/pulls#parameters-2) table.\n\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.22/rest/reference/reactions) reactions.",
|
||||
"description": "Provides details for a review comment.",
|
||||
"tags": [
|
||||
"pulls"
|
||||
],
|
||||
|
|
@ -56988,8 +56988,8 @@
|
|||
{
|
||||
"required": false,
|
||||
"name": "comfort-fade",
|
||||
"note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.22/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```",
|
||||
"html": "<p>Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.22/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.comfort-fade-preview+json</code></pre>"
|
||||
"note": "Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for more information.\n\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.22/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```\n\nTo show multi-line comment-supported fields in the response, use the `comfort-fade` preview header and the `line` parameter.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute.",
|
||||
"html": "<p>Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the <a href=\"https://developer.github.com/changes/2019-10-03-multi-line-comments\">blog post</a> for more information.</p>\n<p>To create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.22/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.comfort-fade-preview+json</code></pre>\n<p>To show multi-line comment-supported fields in the response, use the <code>comfort-fade</code> preview header and the <code>line</code> parameter.</p>\n<p>If you use the <code>comfort-fade</code> preview header, your response will show:</p>\n<ul>\n<li>For multi-line comments, values for <code>start_line</code>, <code>original_start_line</code>, <code>start_side</code>, <code>line</code>, <code>original_line</code>, and <code>side</code>.</li>\n<li>For single-line comments, values for <code>line</code>, <code>original_line</code>, and <code>side</code> and a <code>null</code> value for <code>start_line</code>, <code>original_start_line</code>, and <code>start_side</code>.</li>\n</ul>\n<p>If you don't use the <code>comfort-fade</code> preview header, multi-line and single-line comments will appear the same way in the response with a single <code>position</code> attribute. Your response will show:</p>\n<ul>\n<li>For multi-line comments, the last line of the comment range for the <code>position</code> attribute.</li>\n<li>For single-line comments, the diff-positioned way of referencing comments for the <code>position</code> attribute.</li>\n</ul>"
|
||||
},
|
||||
{
|
||||
"required": false,
|
||||
|
|
@ -57008,7 +57008,7 @@
|
|||
"subcategoryLabel": "Comments",
|
||||
"notes": [],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p><strong>Note:</strong> Multi-line comments on pull requests are currently in public beta and subject to change.</p>\n<p>Provides details for a review comment.</p>\n<p><strong>Multi-line comment summary</strong></p>\n<p><strong>Note:</strong> New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the <a href=\"https://developer.github.com/changes/2019-10-03-multi-line-comments\">blog post</a> for full details.</p>\n<p>Use the <code>comfort-fade</code> preview header and the <code>line</code> parameter to show multi-line comment-supported fields in the response.</p>\n<p>If you use the <code>comfort-fade</code> preview header, your response will show:</p>\n<ul>\n<li>For multi-line comments, values for <code>start_line</code>, <code>original_start_line</code>, <code>start_side</code>, <code>line</code>, <code>original_line</code>, and <code>side</code>.</li>\n<li>For single-line comments, values for <code>line</code>, <code>original_line</code>, and <code>side</code> and a <code>null</code> value for <code>start_line</code>, <code>original_start_line</code>, and <code>start_side</code>.</li>\n</ul>\n<p>If you don't use the <code>comfort-fade</code> preview header, multi-line and single-line comments will appear the same way in the response with a single <code>position</code> attribute. Your response will show:</p>\n<ul>\n<li>For multi-line comments, the last line of the comment range for the <code>position</code> attribute.</li>\n<li>For single-line comments, the diff-positioned way of referencing comments for the <code>position</code> attribute. For more information, see <code>position</code> in the <a href=\"https://docs.github.com/enterprise-server@2.22/rest/reference/pulls#parameters-2\">input parameters</a> table.</li>\n</ul>\n<p>The <code>reactions</code> key will have the following payload where <code>url</code> can be used to construct the API location for <a href=\"https://docs.github.com/enterprise-server@2.22/rest/reference/reactions\">listing and creating</a> reactions.</p>",
|
||||
"descriptionHTML": "<p>Provides details for a review comment.</p>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
|
|
@ -57070,7 +57070,7 @@
|
|||
}
|
||||
],
|
||||
"summary": "Update a review comment for a pull request",
|
||||
"description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nEnables you to edit a review comment.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/enterprise-server@2.22/rest/reference/pulls#parameters-2) table.",
|
||||
"description": "Enables you to edit a review comment.",
|
||||
"tags": [
|
||||
"pulls"
|
||||
],
|
||||
|
|
@ -57112,8 +57112,8 @@
|
|||
{
|
||||
"required": false,
|
||||
"name": "comfort-fade",
|
||||
"note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.22/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```",
|
||||
"html": "<p>Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.22/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.comfort-fade-preview+json</code></pre>"
|
||||
"note": "Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for more information.\n\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.22/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```\n\nTo show multi-line comment-supported fields in the response, use the `comfort-fade` preview header and the `line` parameter.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute.",
|
||||
"html": "<p>Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the <a href=\"https://developer.github.com/changes/2019-10-03-multi-line-comments\">blog post</a> for more information.</p>\n<p>To create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.22/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.comfort-fade-preview+json</code></pre>\n<p>To show multi-line comment-supported fields in the response, use the <code>comfort-fade</code> preview header and the <code>line</code> parameter.</p>\n<p>If you use the <code>comfort-fade</code> preview header, your response will show:</p>\n<ul>\n<li>For multi-line comments, values for <code>start_line</code>, <code>original_start_line</code>, <code>start_side</code>, <code>line</code>, <code>original_line</code>, and <code>side</code>.</li>\n<li>For single-line comments, values for <code>line</code>, <code>original_line</code>, and <code>side</code> and a <code>null</code> value for <code>start_line</code>, <code>original_start_line</code>, and <code>start_side</code>.</li>\n</ul>\n<p>If you don't use the <code>comfort-fade</code> preview header, multi-line and single-line comments will appear the same way in the response with a single <code>position</code> attribute. Your response will show:</p>\n<ul>\n<li>For multi-line comments, the last line of the comment range for the <code>position</code> attribute.</li>\n<li>For single-line comments, the diff-positioned way of referencing comments for the <code>position</code> attribute.</li>\n</ul>"
|
||||
}
|
||||
],
|
||||
"category": "pulls",
|
||||
|
|
@ -57125,7 +57125,7 @@
|
|||
"subcategory": "comments",
|
||||
"subcategoryLabel": "Comments",
|
||||
"notes": [],
|
||||
"descriptionHTML": "<p><strong>Note:</strong> Multi-line comments on pull requests are currently in public beta and subject to change.</p>\n<p>Enables you to edit a review comment.</p>\n<p><strong>Multi-line comment summary</strong></p>\n<p><strong>Note:</strong> New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the <a href=\"https://developer.github.com/changes/2019-10-03-multi-line-comments\">blog post</a> for full details.</p>\n<p>Use the <code>comfort-fade</code> preview header and the <code>line</code> parameter to show multi-line comment-supported fields in the response.</p>\n<p>If you use the <code>comfort-fade</code> preview header, your response will show:</p>\n<ul>\n<li>For multi-line comments, values for <code>start_line</code>, <code>original_start_line</code>, <code>start_side</code>, <code>line</code>, <code>original_line</code>, and <code>side</code>.</li>\n<li>For single-line comments, values for <code>line</code>, <code>original_line</code>, and <code>side</code> and a <code>null</code> value for <code>start_line</code>, <code>original_start_line</code>, and <code>start_side</code>.</li>\n</ul>\n<p>If you don't use the <code>comfort-fade</code> preview header, multi-line and single-line comments will appear the same way in the response with a single <code>position</code> attribute. Your response will show:</p>\n<ul>\n<li>For multi-line comments, the last line of the comment range for the <code>position</code> attribute.</li>\n<li>For single-line comments, the diff-positioned way of referencing comments for the <code>position</code> attribute. For more information, see <code>position</code> in the <a href=\"https://docs.github.com/enterprise-server@2.22/rest/reference/pulls#parameters-2\">input parameters</a> table.</li>\n</ul>",
|
||||
"descriptionHTML": "<p>Enables you to edit a review comment.</p>",
|
||||
"bodyParameters": [
|
||||
{
|
||||
"type": "string",
|
||||
|
|
@ -58015,7 +58015,7 @@
|
|||
}
|
||||
],
|
||||
"summary": "List review comments on a pull request",
|
||||
"description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nLists all review comments for a pull request. By default, review comments are in ascending order by ID.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/enterprise-server@2.22/rest/reference/pulls#parameters-2) table.\n\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.22/rest/reference/reactions) reactions.",
|
||||
"description": "Lists all review comments for a pull request. By default, review comments are in ascending order by ID.",
|
||||
"tags": [
|
||||
"pulls"
|
||||
],
|
||||
|
|
@ -58031,8 +58031,8 @@
|
|||
{
|
||||
"required": false,
|
||||
"name": "comfort-fade",
|
||||
"note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.22/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```",
|
||||
"html": "<p>Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.22/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.comfort-fade-preview+json</code></pre>"
|
||||
"note": "Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for more information.\n\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.22/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```\n\nTo show multi-line comment-supported fields in the response, use the `comfort-fade` preview header and the `line` parameter.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute.",
|
||||
"html": "<p>Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the <a href=\"https://developer.github.com/changes/2019-10-03-multi-line-comments\">blog post</a> for more information.</p>\n<p>To create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.22/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.comfort-fade-preview+json</code></pre>\n<p>To show multi-line comment-supported fields in the response, use the <code>comfort-fade</code> preview header and the <code>line</code> parameter.</p>\n<p>If you use the <code>comfort-fade</code> preview header, your response will show:</p>\n<ul>\n<li>For multi-line comments, values for <code>start_line</code>, <code>original_start_line</code>, <code>start_side</code>, <code>line</code>, <code>original_line</code>, and <code>side</code>.</li>\n<li>For single-line comments, values for <code>line</code>, <code>original_line</code>, and <code>side</code> and a <code>null</code> value for <code>start_line</code>, <code>original_start_line</code>, and <code>start_side</code>.</li>\n</ul>\n<p>If you don't use the <code>comfort-fade</code> preview header, multi-line and single-line comments will appear the same way in the response with a single <code>position</code> attribute. Your response will show:</p>\n<ul>\n<li>For multi-line comments, the last line of the comment range for the <code>position</code> attribute.</li>\n<li>For single-line comments, the diff-positioned way of referencing comments for the <code>position</code> attribute.</li>\n</ul>"
|
||||
},
|
||||
{
|
||||
"required": false,
|
||||
|
|
@ -58051,7 +58051,7 @@
|
|||
"subcategoryLabel": "Comments",
|
||||
"notes": [],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p><strong>Note:</strong> Multi-line comments on pull requests are currently in public beta and subject to change.</p>\n<p>Lists all review comments for a pull request. By default, review comments are in ascending order by ID.</p>\n<p><strong>Multi-line comment summary</strong></p>\n<p><strong>Note:</strong> New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the <a href=\"https://developer.github.com/changes/2019-10-03-multi-line-comments\">blog post</a> for full details.</p>\n<p>Use the <code>comfort-fade</code> preview header and the <code>line</code> parameter to show multi-line comment-supported fields in the response.</p>\n<p>If you use the <code>comfort-fade</code> preview header, your response will show:</p>\n<ul>\n<li>For multi-line comments, values for <code>start_line</code>, <code>original_start_line</code>, <code>start_side</code>, <code>line</code>, <code>original_line</code>, and <code>side</code>.</li>\n<li>For single-line comments, values for <code>line</code>, <code>original_line</code>, and <code>side</code> and a <code>null</code> value for <code>start_line</code>, <code>original_start_line</code>, and <code>start_side</code>.</li>\n</ul>\n<p>If you don't use the <code>comfort-fade</code> preview header, multi-line and single-line comments will appear the same way in the response with a single <code>position</code> attribute. Your response will show:</p>\n<ul>\n<li>For multi-line comments, the last line of the comment range for the <code>position</code> attribute.</li>\n<li>For single-line comments, the diff-positioned way of referencing comments for the <code>position</code> attribute. For more information, see <code>position</code> in the <a href=\"https://docs.github.com/enterprise-server@2.22/rest/reference/pulls#parameters-2\">input parameters</a> table.</li>\n</ul>\n<p>The <code>reactions</code> key will have the following payload where <code>url</code> can be used to construct the API location for <a href=\"https://docs.github.com/enterprise-server@2.22/rest/reference/reactions\">listing and creating</a> reactions.</p>",
|
||||
"descriptionHTML": "<p>Lists all review comments for a pull request. By default, review comments are in ascending order by ID.</p>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
|
|
@ -58107,7 +58107,7 @@
|
|||
}
|
||||
],
|
||||
"summary": "Create a review comment for a pull request",
|
||||
"description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nCreates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"[Create an issue comment](https://docs.github.com/enterprise-server@2.22/rest/reference/issues#create-an-issue-comment).\" We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff.\n\nYou can still create a review comment using the `position` parameter. When you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. For more information, see [Multi-line comment summary](https://docs.github.com/enterprise-server@2.22/rest/reference/pulls#multi-line-comment-summary-3).\n\n**Note:** The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.22/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.22/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/enterprise-server@2.22/rest/reference/pulls#parameters-2) table.",
|
||||
"description": "\nCreates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"[Create an issue comment](https://docs.github.com/enterprise-server@2.22/rest/reference/issues#create-an-issue-comment).\" We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff.\n\nYou can still create a review comment using the `position` parameter. When you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. For more information, see the [`comfort-fade` preview notice](https://docs.github.com/enterprise-server@2.22/rest/reference/pulls#create-a-review-comment-for-a-pull-request-preview-notices).\n\n**Note:** The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.22/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.22/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.",
|
||||
"tags": [
|
||||
"pulls"
|
||||
],
|
||||
|
|
@ -58253,8 +58253,8 @@
|
|||
{
|
||||
"required": false,
|
||||
"name": "comfort-fade",
|
||||
"note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.22/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```",
|
||||
"html": "<p>Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.22/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.comfort-fade-preview+json</code></pre>"
|
||||
"note": "Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for more information.\n\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.22/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```\n\nTo show multi-line comment-supported fields in the response, use the `comfort-fade` preview header and the `line` parameter.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute.",
|
||||
"html": "<p>Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the <a href=\"https://developer.github.com/changes/2019-10-03-multi-line-comments\">blog post</a> for more information.</p>\n<p>To create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.22/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.comfort-fade-preview+json</code></pre>\n<p>To show multi-line comment-supported fields in the response, use the <code>comfort-fade</code> preview header and the <code>line</code> parameter.</p>\n<p>If you use the <code>comfort-fade</code> preview header, your response will show:</p>\n<ul>\n<li>For multi-line comments, values for <code>start_line</code>, <code>original_start_line</code>, <code>start_side</code>, <code>line</code>, <code>original_line</code>, and <code>side</code>.</li>\n<li>For single-line comments, values for <code>line</code>, <code>original_line</code>, and <code>side</code> and a <code>null</code> value for <code>start_line</code>, <code>original_start_line</code>, and <code>start_side</code>.</li>\n</ul>\n<p>If you don't use the <code>comfort-fade</code> preview header, multi-line and single-line comments will appear the same way in the response with a single <code>position</code> attribute. Your response will show:</p>\n<ul>\n<li>For multi-line comments, the last line of the comment range for the <code>position</code> attribute.</li>\n<li>For single-line comments, the diff-positioned way of referencing comments for the <code>position</code> attribute.</li>\n</ul>"
|
||||
}
|
||||
],
|
||||
"category": "pulls",
|
||||
|
|
@ -58266,7 +58266,7 @@
|
|||
"subcategory": "comments",
|
||||
"subcategoryLabel": "Comments",
|
||||
"notes": [],
|
||||
"descriptionHTML": "<p><strong>Note:</strong> Multi-line comments on pull requests are currently in public beta and subject to change.</p>\n<p>Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"<a href=\"https://docs.github.com/enterprise-server@2.22/rest/reference/issues#create-an-issue-comment\">Create an issue comment</a>.\" We recommend creating a review comment using <code>line</code>, <code>side</code>, and optionally <code>start_line</code> and <code>start_side</code> if your comment applies to more than one line in the pull request diff.</p>\n<p>You can still create a review comment using the <code>position</code> parameter. When you use <code>position</code>, the <code>line</code>, <code>side</code>, <code>start_line</code>, and <code>start_side</code> parameters are not required. For more information, see <a href=\"https://docs.github.com/enterprise-server@2.22/rest/reference/pulls#multi-line-comment-summary-3\">Multi-line comment summary</a>.</p>\n<p><strong>Note:</strong> The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.</p>\n<p>This endpoint triggers <a href=\"https://help.github.com/articles/about-notifications/\">notifications</a>. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"<a href=\"https://docs.github.com/enterprise-server@2.22/rest/overview/resources-in-the-rest-api#abuse-rate-limits\">Abuse rate limits</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@2.22/rest/guides/best-practices-for-integrators#dealing-with-rate-limits\">Dealing with abuse rate limits</a>\" for details.</p>\n<p><strong>Multi-line comment summary</strong></p>\n<p><strong>Note:</strong> New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the <a href=\"https://developer.github.com/changes/2019-10-03-multi-line-comments\">blog post</a> for full details.</p>\n<p>Use the <code>comfort-fade</code> preview header and the <code>line</code> parameter to show multi-line comment-supported fields in the response.</p>\n<p>If you use the <code>comfort-fade</code> preview header, your response will show:</p>\n<ul>\n<li>For multi-line comments, values for <code>start_line</code>, <code>original_start_line</code>, <code>start_side</code>, <code>line</code>, <code>original_line</code>, and <code>side</code>.</li>\n<li>For single-line comments, values for <code>line</code>, <code>original_line</code>, and <code>side</code> and a <code>null</code> value for <code>start_line</code>, <code>original_start_line</code>, and <code>start_side</code>.</li>\n</ul>\n<p>If you don't use the <code>comfort-fade</code> preview header, multi-line and single-line comments will appear the same way in the response with a single <code>position</code> attribute. Your response will show:</p>\n<ul>\n<li>For multi-line comments, the last line of the comment range for the <code>position</code> attribute.</li>\n<li>For single-line comments, the diff-positioned way of referencing comments for the <code>position</code> attribute. For more information, see <code>position</code> in the <a href=\"https://docs.github.com/enterprise-server@2.22/rest/reference/pulls#parameters-2\">input parameters</a> table.</li>\n</ul>",
|
||||
"descriptionHTML": "<p>Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"<a href=\"https://docs.github.com/enterprise-server@2.22/rest/reference/issues#create-an-issue-comment\">Create an issue comment</a>.\" We recommend creating a review comment using <code>line</code>, <code>side</code>, and optionally <code>start_line</code> and <code>start_side</code> if your comment applies to more than one line in the pull request diff.</p>\n<p>You can still create a review comment using the <code>position</code> parameter. When you use <code>position</code>, the <code>line</code>, <code>side</code>, <code>start_line</code>, and <code>start_side</code> parameters are not required. For more information, see the <a href=\"https://docs.github.com/enterprise-server@2.22/rest/reference/pulls#create-a-review-comment-for-a-pull-request-preview-notices\"><code>comfort-fade</code> preview notice</a>.</p>\n<p><strong>Note:</strong> The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.</p>\n<p>This endpoint triggers <a href=\"https://help.github.com/articles/about-notifications/\">notifications</a>. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"<a href=\"https://docs.github.com/enterprise-server@2.22/rest/overview/resources-in-the-rest-api#abuse-rate-limits\">Abuse rate limits</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@2.22/rest/guides/best-practices-for-integrators#dealing-with-rate-limits\">Dealing with abuse rate limits</a>\" for details.</p>",
|
||||
"bodyParameters": [
|
||||
{
|
||||
"type": "string",
|
||||
|
|
@ -72691,11 +72691,6 @@
|
|||
"httpStatusMessage": "Forbidden",
|
||||
"description": "Forbidden"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "418",
|
||||
"httpStatusMessage": "I'm A Teapot",
|
||||
"description": "Response definition missing"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "422",
|
||||
"httpStatusMessage": "Unprocessable Entity",
|
||||
|
|
|
|||
|
|
@ -47139,7 +47139,7 @@
|
|||
}
|
||||
],
|
||||
"summary": "List review comments in a repository",
|
||||
"description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nLists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/github-ae@latest/rest/reference/pulls#parameters-2) table.\n\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/github-ae@latest/rest/reference/reactions) reactions.",
|
||||
"description": "Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.",
|
||||
"tags": [
|
||||
"pulls"
|
||||
],
|
||||
|
|
@ -47155,8 +47155,8 @@
|
|||
{
|
||||
"required": false,
|
||||
"name": "comfort-fade",
|
||||
"note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```",
|
||||
"html": "<p>Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.comfort-fade-preview+json</code></pre>"
|
||||
"note": "Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for more information.\n\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```\n\nTo show multi-line comment-supported fields in the response, use the `comfort-fade` preview header and the `line` parameter.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute.",
|
||||
"html": "<p>Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the <a href=\"https://developer.github.com/changes/2019-10-03-multi-line-comments\">blog post</a> for more information.</p>\n<p>To create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.comfort-fade-preview+json</code></pre>\n<p>To show multi-line comment-supported fields in the response, use the <code>comfort-fade</code> preview header and the <code>line</code> parameter.</p>\n<p>If you use the <code>comfort-fade</code> preview header, your response will show:</p>\n<ul>\n<li>For multi-line comments, values for <code>start_line</code>, <code>original_start_line</code>, <code>start_side</code>, <code>line</code>, <code>original_line</code>, and <code>side</code>.</li>\n<li>For single-line comments, values for <code>line</code>, <code>original_line</code>, and <code>side</code> and a <code>null</code> value for <code>start_line</code>, <code>original_start_line</code>, and <code>start_side</code>.</li>\n</ul>\n<p>If you don't use the <code>comfort-fade</code> preview header, multi-line and single-line comments will appear the same way in the response with a single <code>position</code> attribute. Your response will show:</p>\n<ul>\n<li>For multi-line comments, the last line of the comment range for the <code>position</code> attribute.</li>\n<li>For single-line comments, the diff-positioned way of referencing comments for the <code>position</code> attribute.</li>\n</ul>"
|
||||
},
|
||||
{
|
||||
"required": false,
|
||||
|
|
@ -47175,7 +47175,7 @@
|
|||
"subcategoryLabel": "Comments",
|
||||
"notes": [],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p><strong>Note:</strong> Multi-line comments on pull requests are currently in public beta and subject to change.</p>\n<p>Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.</p>\n<p><strong>Multi-line comment summary</strong></p>\n<p><strong>Note:</strong> New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the <a href=\"https://developer.github.com/changes/2019-10-03-multi-line-comments\">blog post</a> for full details.</p>\n<p>Use the <code>comfort-fade</code> preview header and the <code>line</code> parameter to show multi-line comment-supported fields in the response.</p>\n<p>If you use the <code>comfort-fade</code> preview header, your response will show:</p>\n<ul>\n<li>For multi-line comments, values for <code>start_line</code>, <code>original_start_line</code>, <code>start_side</code>, <code>line</code>, <code>original_line</code>, and <code>side</code>.</li>\n<li>For single-line comments, values for <code>line</code>, <code>original_line</code>, and <code>side</code> and a <code>null</code> value for <code>start_line</code>, <code>original_start_line</code>, and <code>start_side</code>.</li>\n</ul>\n<p>If you don't use the <code>comfort-fade</code> preview header, multi-line and single-line comments will appear the same way in the response with a single <code>position</code> attribute. Your response will show:</p>\n<ul>\n<li>For multi-line comments, the last line of the comment range for the <code>position</code> attribute.</li>\n<li>For single-line comments, the diff-positioned way of referencing comments for the <code>position</code> attribute. For more information, see <code>position</code> in the <a href=\"https://docs.github.com/github-ae@latest/rest/reference/pulls#parameters-2\">input parameters</a> table.</li>\n</ul>\n<p>The <code>reactions</code> key will have the following payload where <code>url</code> can be used to construct the API location for <a href=\"https://docs.github.com/github-ae@latest/rest/reference/reactions\">listing and creating</a> reactions.</p>",
|
||||
"descriptionHTML": "<p>Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.</p>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
|
|
@ -47232,7 +47232,7 @@
|
|||
}
|
||||
],
|
||||
"summary": "Get a review comment for a pull request",
|
||||
"description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nProvides details for a review comment.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/github-ae@latest/rest/reference/pulls#parameters-2) table.\n\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/github-ae@latest/rest/reference/reactions) reactions.",
|
||||
"description": "Provides details for a review comment.",
|
||||
"tags": [
|
||||
"pulls"
|
||||
],
|
||||
|
|
@ -47248,8 +47248,8 @@
|
|||
{
|
||||
"required": false,
|
||||
"name": "comfort-fade",
|
||||
"note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```",
|
||||
"html": "<p>Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.comfort-fade-preview+json</code></pre>"
|
||||
"note": "Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for more information.\n\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```\n\nTo show multi-line comment-supported fields in the response, use the `comfort-fade` preview header and the `line` parameter.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute.",
|
||||
"html": "<p>Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the <a href=\"https://developer.github.com/changes/2019-10-03-multi-line-comments\">blog post</a> for more information.</p>\n<p>To create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.comfort-fade-preview+json</code></pre>\n<p>To show multi-line comment-supported fields in the response, use the <code>comfort-fade</code> preview header and the <code>line</code> parameter.</p>\n<p>If you use the <code>comfort-fade</code> preview header, your response will show:</p>\n<ul>\n<li>For multi-line comments, values for <code>start_line</code>, <code>original_start_line</code>, <code>start_side</code>, <code>line</code>, <code>original_line</code>, and <code>side</code>.</li>\n<li>For single-line comments, values for <code>line</code>, <code>original_line</code>, and <code>side</code> and a <code>null</code> value for <code>start_line</code>, <code>original_start_line</code>, and <code>start_side</code>.</li>\n</ul>\n<p>If you don't use the <code>comfort-fade</code> preview header, multi-line and single-line comments will appear the same way in the response with a single <code>position</code> attribute. Your response will show:</p>\n<ul>\n<li>For multi-line comments, the last line of the comment range for the <code>position</code> attribute.</li>\n<li>For single-line comments, the diff-positioned way of referencing comments for the <code>position</code> attribute.</li>\n</ul>"
|
||||
},
|
||||
{
|
||||
"required": false,
|
||||
|
|
@ -47268,7 +47268,7 @@
|
|||
"subcategoryLabel": "Comments",
|
||||
"notes": [],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p><strong>Note:</strong> Multi-line comments on pull requests are currently in public beta and subject to change.</p>\n<p>Provides details for a review comment.</p>\n<p><strong>Multi-line comment summary</strong></p>\n<p><strong>Note:</strong> New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the <a href=\"https://developer.github.com/changes/2019-10-03-multi-line-comments\">blog post</a> for full details.</p>\n<p>Use the <code>comfort-fade</code> preview header and the <code>line</code> parameter to show multi-line comment-supported fields in the response.</p>\n<p>If you use the <code>comfort-fade</code> preview header, your response will show:</p>\n<ul>\n<li>For multi-line comments, values for <code>start_line</code>, <code>original_start_line</code>, <code>start_side</code>, <code>line</code>, <code>original_line</code>, and <code>side</code>.</li>\n<li>For single-line comments, values for <code>line</code>, <code>original_line</code>, and <code>side</code> and a <code>null</code> value for <code>start_line</code>, <code>original_start_line</code>, and <code>start_side</code>.</li>\n</ul>\n<p>If you don't use the <code>comfort-fade</code> preview header, multi-line and single-line comments will appear the same way in the response with a single <code>position</code> attribute. Your response will show:</p>\n<ul>\n<li>For multi-line comments, the last line of the comment range for the <code>position</code> attribute.</li>\n<li>For single-line comments, the diff-positioned way of referencing comments for the <code>position</code> attribute. For more information, see <code>position</code> in the <a href=\"https://docs.github.com/github-ae@latest/rest/reference/pulls#parameters-2\">input parameters</a> table.</li>\n</ul>\n<p>The <code>reactions</code> key will have the following payload where <code>url</code> can be used to construct the API location for <a href=\"https://docs.github.com/github-ae@latest/rest/reference/reactions\">listing and creating</a> reactions.</p>",
|
||||
"descriptionHTML": "<p>Provides details for a review comment.</p>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
|
|
@ -47330,7 +47330,7 @@
|
|||
}
|
||||
],
|
||||
"summary": "Update a review comment for a pull request",
|
||||
"description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nEnables you to edit a review comment.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/github-ae@latest/rest/reference/pulls#parameters-2) table.",
|
||||
"description": "Enables you to edit a review comment.",
|
||||
"tags": [
|
||||
"pulls"
|
||||
],
|
||||
|
|
@ -47372,8 +47372,8 @@
|
|||
{
|
||||
"required": false,
|
||||
"name": "comfort-fade",
|
||||
"note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```",
|
||||
"html": "<p>Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.comfort-fade-preview+json</code></pre>"
|
||||
"note": "Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for more information.\n\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```\n\nTo show multi-line comment-supported fields in the response, use the `comfort-fade` preview header and the `line` parameter.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute.",
|
||||
"html": "<p>Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the <a href=\"https://developer.github.com/changes/2019-10-03-multi-line-comments\">blog post</a> for more information.</p>\n<p>To create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.comfort-fade-preview+json</code></pre>\n<p>To show multi-line comment-supported fields in the response, use the <code>comfort-fade</code> preview header and the <code>line</code> parameter.</p>\n<p>If you use the <code>comfort-fade</code> preview header, your response will show:</p>\n<ul>\n<li>For multi-line comments, values for <code>start_line</code>, <code>original_start_line</code>, <code>start_side</code>, <code>line</code>, <code>original_line</code>, and <code>side</code>.</li>\n<li>For single-line comments, values for <code>line</code>, <code>original_line</code>, and <code>side</code> and a <code>null</code> value for <code>start_line</code>, <code>original_start_line</code>, and <code>start_side</code>.</li>\n</ul>\n<p>If you don't use the <code>comfort-fade</code> preview header, multi-line and single-line comments will appear the same way in the response with a single <code>position</code> attribute. Your response will show:</p>\n<ul>\n<li>For multi-line comments, the last line of the comment range for the <code>position</code> attribute.</li>\n<li>For single-line comments, the diff-positioned way of referencing comments for the <code>position</code> attribute.</li>\n</ul>"
|
||||
}
|
||||
],
|
||||
"category": "pulls",
|
||||
|
|
@ -47385,7 +47385,7 @@
|
|||
"subcategory": "comments",
|
||||
"subcategoryLabel": "Comments",
|
||||
"notes": [],
|
||||
"descriptionHTML": "<p><strong>Note:</strong> Multi-line comments on pull requests are currently in public beta and subject to change.</p>\n<p>Enables you to edit a review comment.</p>\n<p><strong>Multi-line comment summary</strong></p>\n<p><strong>Note:</strong> New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the <a href=\"https://developer.github.com/changes/2019-10-03-multi-line-comments\">blog post</a> for full details.</p>\n<p>Use the <code>comfort-fade</code> preview header and the <code>line</code> parameter to show multi-line comment-supported fields in the response.</p>\n<p>If you use the <code>comfort-fade</code> preview header, your response will show:</p>\n<ul>\n<li>For multi-line comments, values for <code>start_line</code>, <code>original_start_line</code>, <code>start_side</code>, <code>line</code>, <code>original_line</code>, and <code>side</code>.</li>\n<li>For single-line comments, values for <code>line</code>, <code>original_line</code>, and <code>side</code> and a <code>null</code> value for <code>start_line</code>, <code>original_start_line</code>, and <code>start_side</code>.</li>\n</ul>\n<p>If you don't use the <code>comfort-fade</code> preview header, multi-line and single-line comments will appear the same way in the response with a single <code>position</code> attribute. Your response will show:</p>\n<ul>\n<li>For multi-line comments, the last line of the comment range for the <code>position</code> attribute.</li>\n<li>For single-line comments, the diff-positioned way of referencing comments for the <code>position</code> attribute. For more information, see <code>position</code> in the <a href=\"https://docs.github.com/github-ae@latest/rest/reference/pulls#parameters-2\">input parameters</a> table.</li>\n</ul>",
|
||||
"descriptionHTML": "<p>Enables you to edit a review comment.</p>",
|
||||
"bodyParameters": [
|
||||
{
|
||||
"type": "string",
|
||||
|
|
@ -48275,7 +48275,7 @@
|
|||
}
|
||||
],
|
||||
"summary": "List review comments on a pull request",
|
||||
"description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nLists all review comments for a pull request. By default, review comments are in ascending order by ID.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/github-ae@latest/rest/reference/pulls#parameters-2) table.\n\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/github-ae@latest/rest/reference/reactions) reactions.",
|
||||
"description": "Lists all review comments for a pull request. By default, review comments are in ascending order by ID.",
|
||||
"tags": [
|
||||
"pulls"
|
||||
],
|
||||
|
|
@ -48291,8 +48291,8 @@
|
|||
{
|
||||
"required": false,
|
||||
"name": "comfort-fade",
|
||||
"note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```",
|
||||
"html": "<p>Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.comfort-fade-preview+json</code></pre>"
|
||||
"note": "Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for more information.\n\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```\n\nTo show multi-line comment-supported fields in the response, use the `comfort-fade` preview header and the `line` parameter.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute.",
|
||||
"html": "<p>Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the <a href=\"https://developer.github.com/changes/2019-10-03-multi-line-comments\">blog post</a> for more information.</p>\n<p>To create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.comfort-fade-preview+json</code></pre>\n<p>To show multi-line comment-supported fields in the response, use the <code>comfort-fade</code> preview header and the <code>line</code> parameter.</p>\n<p>If you use the <code>comfort-fade</code> preview header, your response will show:</p>\n<ul>\n<li>For multi-line comments, values for <code>start_line</code>, <code>original_start_line</code>, <code>start_side</code>, <code>line</code>, <code>original_line</code>, and <code>side</code>.</li>\n<li>For single-line comments, values for <code>line</code>, <code>original_line</code>, and <code>side</code> and a <code>null</code> value for <code>start_line</code>, <code>original_start_line</code>, and <code>start_side</code>.</li>\n</ul>\n<p>If you don't use the <code>comfort-fade</code> preview header, multi-line and single-line comments will appear the same way in the response with a single <code>position</code> attribute. Your response will show:</p>\n<ul>\n<li>For multi-line comments, the last line of the comment range for the <code>position</code> attribute.</li>\n<li>For single-line comments, the diff-positioned way of referencing comments for the <code>position</code> attribute.</li>\n</ul>"
|
||||
},
|
||||
{
|
||||
"required": false,
|
||||
|
|
@ -48311,7 +48311,7 @@
|
|||
"subcategoryLabel": "Comments",
|
||||
"notes": [],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p><strong>Note:</strong> Multi-line comments on pull requests are currently in public beta and subject to change.</p>\n<p>Lists all review comments for a pull request. By default, review comments are in ascending order by ID.</p>\n<p><strong>Multi-line comment summary</strong></p>\n<p><strong>Note:</strong> New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the <a href=\"https://developer.github.com/changes/2019-10-03-multi-line-comments\">blog post</a> for full details.</p>\n<p>Use the <code>comfort-fade</code> preview header and the <code>line</code> parameter to show multi-line comment-supported fields in the response.</p>\n<p>If you use the <code>comfort-fade</code> preview header, your response will show:</p>\n<ul>\n<li>For multi-line comments, values for <code>start_line</code>, <code>original_start_line</code>, <code>start_side</code>, <code>line</code>, <code>original_line</code>, and <code>side</code>.</li>\n<li>For single-line comments, values for <code>line</code>, <code>original_line</code>, and <code>side</code> and a <code>null</code> value for <code>start_line</code>, <code>original_start_line</code>, and <code>start_side</code>.</li>\n</ul>\n<p>If you don't use the <code>comfort-fade</code> preview header, multi-line and single-line comments will appear the same way in the response with a single <code>position</code> attribute. Your response will show:</p>\n<ul>\n<li>For multi-line comments, the last line of the comment range for the <code>position</code> attribute.</li>\n<li>For single-line comments, the diff-positioned way of referencing comments for the <code>position</code> attribute. For more information, see <code>position</code> in the <a href=\"https://docs.github.com/github-ae@latest/rest/reference/pulls#parameters-2\">input parameters</a> table.</li>\n</ul>\n<p>The <code>reactions</code> key will have the following payload where <code>url</code> can be used to construct the API location for <a href=\"https://docs.github.com/github-ae@latest/rest/reference/reactions\">listing and creating</a> reactions.</p>",
|
||||
"descriptionHTML": "<p>Lists all review comments for a pull request. By default, review comments are in ascending order by ID.</p>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
|
|
@ -48367,7 +48367,7 @@
|
|||
}
|
||||
],
|
||||
"summary": "Create a review comment for a pull request",
|
||||
"description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nCreates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"[Create an issue comment](https://docs.github.com/github-ae@latest/rest/reference/issues#create-an-issue-comment).\" We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff.\n\nYou can still create a review comment using the `position` parameter. When you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. For more information, see [Multi-line comment summary](https://docs.github.com/github-ae@latest/rest/reference/pulls#multi-line-comment-summary-3).\n\n**Note:** The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/github-ae@latest/rest/reference/pulls#parameters-2) table.",
|
||||
"description": "\nCreates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"[Create an issue comment](https://docs.github.com/github-ae@latest/rest/reference/issues#create-an-issue-comment).\" We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff.\n\nYou can still create a review comment using the `position` parameter. When you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. For more information, see the [`comfort-fade` preview notice](https://docs.github.com/github-ae@latest/rest/reference/pulls#create-a-review-comment-for-a-pull-request-preview-notices).\n\n**Note:** The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.",
|
||||
"tags": [
|
||||
"pulls"
|
||||
],
|
||||
|
|
@ -48513,8 +48513,8 @@
|
|||
{
|
||||
"required": false,
|
||||
"name": "comfort-fade",
|
||||
"note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```",
|
||||
"html": "<p>Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.comfort-fade-preview+json</code></pre>"
|
||||
"note": "Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for more information.\n\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```\n\nTo show multi-line comment-supported fields in the response, use the `comfort-fade` preview header and the `line` parameter.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute.",
|
||||
"html": "<p>Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the <a href=\"https://developer.github.com/changes/2019-10-03-multi-line-comments\">blog post</a> for more information.</p>\n<p>To create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.comfort-fade-preview+json</code></pre>\n<p>To show multi-line comment-supported fields in the response, use the <code>comfort-fade</code> preview header and the <code>line</code> parameter.</p>\n<p>If you use the <code>comfort-fade</code> preview header, your response will show:</p>\n<ul>\n<li>For multi-line comments, values for <code>start_line</code>, <code>original_start_line</code>, <code>start_side</code>, <code>line</code>, <code>original_line</code>, and <code>side</code>.</li>\n<li>For single-line comments, values for <code>line</code>, <code>original_line</code>, and <code>side</code> and a <code>null</code> value for <code>start_line</code>, <code>original_start_line</code>, and <code>start_side</code>.</li>\n</ul>\n<p>If you don't use the <code>comfort-fade</code> preview header, multi-line and single-line comments will appear the same way in the response with a single <code>position</code> attribute. Your response will show:</p>\n<ul>\n<li>For multi-line comments, the last line of the comment range for the <code>position</code> attribute.</li>\n<li>For single-line comments, the diff-positioned way of referencing comments for the <code>position</code> attribute.</li>\n</ul>"
|
||||
}
|
||||
],
|
||||
"category": "pulls",
|
||||
|
|
@ -48526,7 +48526,7 @@
|
|||
"subcategory": "comments",
|
||||
"subcategoryLabel": "Comments",
|
||||
"notes": [],
|
||||
"descriptionHTML": "<p><strong>Note:</strong> Multi-line comments on pull requests are currently in public beta and subject to change.</p>\n<p>Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"<a href=\"https://docs.github.com/github-ae@latest/rest/reference/issues#create-an-issue-comment\">Create an issue comment</a>.\" We recommend creating a review comment using <code>line</code>, <code>side</code>, and optionally <code>start_line</code> and <code>start_side</code> if your comment applies to more than one line in the pull request diff.</p>\n<p>You can still create a review comment using the <code>position</code> parameter. When you use <code>position</code>, the <code>line</code>, <code>side</code>, <code>start_line</code>, and <code>start_side</code> parameters are not required. For more information, see <a href=\"https://docs.github.com/github-ae@latest/rest/reference/pulls#multi-line-comment-summary-3\">Multi-line comment summary</a>.</p>\n<p><strong>Note:</strong> The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.</p>\n<p>This endpoint triggers <a href=\"https://help.github.com/articles/about-notifications/\">notifications</a>. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"<a href=\"https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#abuse-rate-limits\">Abuse rate limits</a>\" and \"<a href=\"https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-integrators#dealing-with-rate-limits\">Dealing with abuse rate limits</a>\" for details.</p>\n<p><strong>Multi-line comment summary</strong></p>\n<p><strong>Note:</strong> New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the <a href=\"https://developer.github.com/changes/2019-10-03-multi-line-comments\">blog post</a> for full details.</p>\n<p>Use the <code>comfort-fade</code> preview header and the <code>line</code> parameter to show multi-line comment-supported fields in the response.</p>\n<p>If you use the <code>comfort-fade</code> preview header, your response will show:</p>\n<ul>\n<li>For multi-line comments, values for <code>start_line</code>, <code>original_start_line</code>, <code>start_side</code>, <code>line</code>, <code>original_line</code>, and <code>side</code>.</li>\n<li>For single-line comments, values for <code>line</code>, <code>original_line</code>, and <code>side</code> and a <code>null</code> value for <code>start_line</code>, <code>original_start_line</code>, and <code>start_side</code>.</li>\n</ul>\n<p>If you don't use the <code>comfort-fade</code> preview header, multi-line and single-line comments will appear the same way in the response with a single <code>position</code> attribute. Your response will show:</p>\n<ul>\n<li>For multi-line comments, the last line of the comment range for the <code>position</code> attribute.</li>\n<li>For single-line comments, the diff-positioned way of referencing comments for the <code>position</code> attribute. For more information, see <code>position</code> in the <a href=\"https://docs.github.com/github-ae@latest/rest/reference/pulls#parameters-2\">input parameters</a> table.</li>\n</ul>",
|
||||
"descriptionHTML": "<p>Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"<a href=\"https://docs.github.com/github-ae@latest/rest/reference/issues#create-an-issue-comment\">Create an issue comment</a>.\" We recommend creating a review comment using <code>line</code>, <code>side</code>, and optionally <code>start_line</code> and <code>start_side</code> if your comment applies to more than one line in the pull request diff.</p>\n<p>You can still create a review comment using the <code>position</code> parameter. When you use <code>position</code>, the <code>line</code>, <code>side</code>, <code>start_line</code>, and <code>start_side</code> parameters are not required. For more information, see the <a href=\"https://docs.github.com/github-ae@latest/rest/reference/pulls#create-a-review-comment-for-a-pull-request-preview-notices\"><code>comfort-fade</code> preview notice</a>.</p>\n<p><strong>Note:</strong> The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.</p>\n<p>This endpoint triggers <a href=\"https://help.github.com/articles/about-notifications/\">notifications</a>. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"<a href=\"https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#abuse-rate-limits\">Abuse rate limits</a>\" and \"<a href=\"https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-integrators#dealing-with-rate-limits\">Dealing with abuse rate limits</a>\" for details.</p>",
|
||||
"bodyParameters": [
|
||||
{
|
||||
"type": "string",
|
||||
|
|
@ -61722,11 +61722,6 @@
|
|||
"httpStatusMessage": "Forbidden",
|
||||
"description": "Forbidden"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "418",
|
||||
"httpStatusMessage": "I'm A Teapot",
|
||||
"description": "Response definition missing"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "422",
|
||||
"httpStatusMessage": "Unprocessable Entity",
|
||||
|
|
|
|||
Разница между файлами не показана из-за своего большого размера
Загрузить разницу
Разница между файлами не показана из-за своего большого размера
Загрузить разницу
Разница между файлами не показана из-за своего большого размера
Загрузить разницу
Разница между файлами не показана из-за своего большого размера
Загрузить разницу
Разница между файлами не показана из-за своего большого размера
Загрузить разницу
Разница между файлами не показана из-за своего большого размера
Загрузить разницу
Разница между файлами не показана из-за своего большого размера
Загрузить разницу
Загрузка…
Ссылка в новой задаче