From 7855ba53c1843f028bb8a13486347a6c577667b8 Mon Sep 17 00:00:00 2001 From: Riyas Valiyadan Date: Wed, 13 Jan 2021 11:44:12 +0530 Subject: [PATCH 01/21] Update adding-an-existing-project-to-github-using-the-command-line.md --- ...ding-an-existing-project-to-github-using-the-command-line.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/github/importing-your-projects-to-github/adding-an-existing-project-to-github-using-the-command-line.md b/content/github/importing-your-projects-to-github/adding-an-existing-project-to-github-using-the-command-line.md index cde638a77d..d1d0f80df2 100644 --- a/content/github/importing-your-projects-to-github/adding-an-existing-project-to-github-using-the-command-line.md +++ b/content/github/importing-your-projects-to-github/adding-an-existing-project-to-github-using-the-command-line.md @@ -43,7 +43,7 @@ versions: ![Copy remote repository URL field](/assets/images/help/repository/copy-remote-repository-url-quick-setup.png) 8. In Terminal, [add the URL for the remote repository](/articles/adding-a-remote) where your local repository will be pushed. ```shell - $ git remote add origin remote repository URL + $ git remote add origin remote_repository_URL # Sets the new remote $ git remote -v # Verifies the new remote URL From c3dcc2056a5cb989464434afe27344b8f6e0ee59 Mon Sep 17 00:00:00 2001 From: Avinal Kumar <185067@nith.ac.in> Date: Tue, 19 Jan 2021 10:06:38 +0530 Subject: [PATCH 02/21] Improve docs to be more explanatory - Added `{:copy}` snippet to all code blocks. - Added a few descriptions about public and private actions - Changed the order of commands and added a description. --- .../creating-a-docker-container-action.md | 36 ++++++++++--------- 1 file changed, 19 insertions(+), 17 deletions(-) diff --git a/content/actions/creating-actions/creating-a-docker-container-action.md b/content/actions/creating-actions/creating-a-docker-container-action.md index 9d3e36e46f..7566e1689f 100644 --- a/content/actions/creating-actions/creating-a-docker-container-action.md +++ b/content/actions/creating-actions/creating-a-docker-container-action.md @@ -39,7 +39,7 @@ Before you begin, you'll need to create a GitHub repository. 1. From your terminal, change directories into your new repository. - ```shell + ```shell{:copy} cd hello-world-docker-action ``` @@ -48,7 +48,7 @@ Before you begin, you'll need to create a GitHub repository. In your new `hello-world-docker-action` directory, create a new `Dockerfile` file. For more information, see "[Dockerfile support for {% data variables.product.prodname_actions %}](/actions/creating-actions/dockerfile-support-for-github-actions)." **Dockerfile** -```dockerfile +```dockerfile{:copy} # Container image that runs your code FROM alpine:3.10 @@ -65,7 +65,7 @@ Create a new `action.yml` file in the `hello-world-docker-action` directory you {% raw %} **action.yml** -```yaml +```yaml{:copy} # action.yml name: 'Hello World' description: 'Greet someone and record the time' @@ -93,20 +93,14 @@ This metadata defines one `who-to-greet` input and one `time` output parameter. You can choose any base Docker image and, therefore, any language for your action. The following shell script example uses the `who-to-greet` input variable to print "Hello [who-to-greet]" in the log file. -Next, the script gets the current time and sets it as an output variable that actions running later in a job can use. In order for {% data variables.product.prodname_dotcom %} to recognize output variables, you must use a workflow command in a specific syntax: `echo "::set-output name=::"`. For more information, see "[Workflow commands for {% data variables.product.prodname_actions %}](/actions/reference/workflow-commands-for-github-actions#setting-an-output-parameter)." +Next, the script gets the current time and sets it as an output variable that actions running later in a job can use. In order for {% data variables.product.prodname_dotcom %} to recognize output variables, you must use a workflow command in a specific syntax: `echo "::set-output name=::"`. For more information, see "[Workflow commands for {% data variables.product.prodname_actions %}](/actions/reference/workflow-commands-for-github-actions#setting-an-output-parameter)." 1. Create a new `entrypoint.sh` file in the `hello-world-docker-action` directory. -1. Make your `entrypoint.sh` file executable: - - ```shell - chmod +x entrypoint.sh - ``` - 1. Add the following code to your `entrypoint.sh` file. **entrypoint.sh** - ```shell + ```shell{:copy} #!/bin/sh -l echo "Hello $1" @@ -114,6 +108,12 @@ Next, the script gets the current time and sets it as an output variable that ac echo "::set-output name=time::$time" ``` +1. Make your `entrypoint.sh` file executable by running following command on your system: + + ```shell{:copy} + chmod +x entrypoint.sh + ``` + If `entrypoint.sh` executes without any errors, the action's status is set to `success`. You can also explicitly set exit codes in your action's code to provide an action's status. For more information, see "[Setting exit codes for actions](/actions/creating-actions/setting-exit-codes-for-actions)." ### Creating a README @@ -130,7 +130,7 @@ In your `hello-world-docker-action` directory, create a `README.md` file that sp - An example of how to use your action in a workflow. **README.md** -```markdown +```markdown{:copy} # Hello world docker action This action prints "Hello World" or "Hello" + the name of a person to greet to the log. @@ -160,7 +160,7 @@ From your terminal, commit your `action.yml`, `entrypoint.sh`, `Dockerfile`, and It's best practice to also add a version tag for releases of your action. For more information on versioning your action, see "[About actions](/actions/automating-your-workflow-with-github-actions/about-actions#using-release-management-for-actions)." -```shell +```shell{:copy} git add action.yml entrypoint.sh Dockerfile README.md git commit -m "My first action is ready" git tag -a -m "My first action release" v1 @@ -175,11 +175,11 @@ Now you're ready to test your action out in a workflow. When an action is in a p #### Example using a public action -The following workflow code uses the completed hello world action in the public [`actions/hello-world-docker-action`](https://github.com/actions/hello-world-docker-action) repository. Copy the following workflow example code into a `.github/workflows/main.yml` file, but replace the `actions/hello-world-docker-action` with your repository and action name. You can also replace the `who-to-greet` input with your name. +The following workflow code uses the completed hello world action in the public [`actions/hello-world-docker-action`](https://github.com/actions/hello-world-docker-action) repository. Copy the following workflow example code into a `.github/workflows/main.yml` file, but replace the `actions/hello-world-docker-action` with your repository and action name. You can also replace the `who-to-greet` input with your name. Public actions can be used with or without publishing to marketplace. Publishing a public action requires you to add a release version tag. {% raw %} **.github/workflows/main.yml** -```yaml +```yaml{:copy} on: [push] jobs: @@ -189,6 +189,8 @@ jobs: steps: - name: Hello world action step id: hello + # For unpublished actions put /@ + # For published actions put /@ uses: actions/hello-world-docker-action@v1 with: who-to-greet: 'Mona the Octocat' @@ -200,11 +202,11 @@ jobs: #### Example using a private action -Copy the following example workflow code into a `.github/workflows/main.yml` file in your action's repository. You can also replace the `who-to-greet` input with your name. +Copy the following example workflow code into a `.github/workflows/main.yml` file in your action's repository. You can also replace the `who-to-greet` input with your name. You cannot publish a private action to marketplace and can be used only by you in the same repository. {% raw %} **.github/workflows/main.yml** -```yaml +```yaml{:copy} on: [push] jobs: From d1ef194548b814c332cdbecaaeacc412f0a030f3 Mon Sep 17 00:00:00 2001 From: Avinal Kumar <185067@nith.ac.in> Date: Tue, 19 Jan 2021 12:43:56 +0530 Subject: [PATCH 03/21] Update content/actions/creating-actions/creating-a-docker-container-action.md Co-authored-by: Martin Lopes --- .../creating-actions/creating-a-docker-container-action.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/actions/creating-actions/creating-a-docker-container-action.md b/content/actions/creating-actions/creating-a-docker-container-action.md index 7566e1689f..dfa1516568 100644 --- a/content/actions/creating-actions/creating-a-docker-container-action.md +++ b/content/actions/creating-actions/creating-a-docker-container-action.md @@ -202,7 +202,7 @@ jobs: #### Example using a private action -Copy the following example workflow code into a `.github/workflows/main.yml` file in your action's repository. You can also replace the `who-to-greet` input with your name. You cannot publish a private action to marketplace and can be used only by you in the same repository. +Copy the following example workflow code into a `.github/workflows/main.yml` file in your action's repository. You can also replace the `who-to-greet` input with your name. This private action can't be published to {% data variables.product.prodname_marketplace %}, and can only be used in this repository. {% raw %} **.github/workflows/main.yml** From 58c63b1626aee419cf67e6aa576d30994634fdf1 Mon Sep 17 00:00:00 2001 From: Avinal Kumar <185067@nith.ac.in> Date: Tue, 19 Jan 2021 12:44:11 +0530 Subject: [PATCH 04/21] Update content/actions/creating-actions/creating-a-docker-container-action.md Co-authored-by: Martin Lopes --- .../creating-actions/creating-a-docker-container-action.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/actions/creating-actions/creating-a-docker-container-action.md b/content/actions/creating-actions/creating-a-docker-container-action.md index dfa1516568..11d350ebdc 100644 --- a/content/actions/creating-actions/creating-a-docker-container-action.md +++ b/content/actions/creating-actions/creating-a-docker-container-action.md @@ -175,7 +175,7 @@ Now you're ready to test your action out in a workflow. When an action is in a p #### Example using a public action -The following workflow code uses the completed hello world action in the public [`actions/hello-world-docker-action`](https://github.com/actions/hello-world-docker-action) repository. Copy the following workflow example code into a `.github/workflows/main.yml` file, but replace the `actions/hello-world-docker-action` with your repository and action name. You can also replace the `who-to-greet` input with your name. Public actions can be used with or without publishing to marketplace. Publishing a public action requires you to add a release version tag. +The following workflow code uses the completed _hello world_ action in the public [`actions/hello-world-docker-action`](https://github.com/actions/hello-world-docker-action) repository. Copy the following workflow example code into a `.github/workflows/main.yml` file, but replace the `actions/hello-world-docker-action` with your repository and action name. You can also replace the `who-to-greet` input with your name. Public actions can be used even if they're not published to {% data variables.product.prodname_marketplace %}. For more information, see "[Publishing an action](/actions/creating-actions/publishing-actions-in-github-marketplace#publishing-an-action)." {% raw %} **.github/workflows/main.yml** From dac5fb61c7c4d87d9ac6dac24c8d7d2d942c3caa Mon Sep 17 00:00:00 2001 From: Riyas Valiyadan Date: Tue, 19 Jan 2021 18:53:33 +0530 Subject: [PATCH 05/21] Update content/github/importing-your-projects-to-github/adding-an-existing-project-to-github-using-the-command-line.md Co-authored-by: Felicity Chapman --- ...ding-an-existing-project-to-github-using-the-command-line.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/github/importing-your-projects-to-github/adding-an-existing-project-to-github-using-the-command-line.md b/content/github/importing-your-projects-to-github/adding-an-existing-project-to-github-using-the-command-line.md index d1d0f80df2..280c7ab4ab 100644 --- a/content/github/importing-your-projects-to-github/adding-an-existing-project-to-github-using-the-command-line.md +++ b/content/github/importing-your-projects-to-github/adding-an-existing-project-to-github-using-the-command-line.md @@ -43,7 +43,7 @@ versions: ![Copy remote repository URL field](/assets/images/help/repository/copy-remote-repository-url-quick-setup.png) 8. In Terminal, [add the URL for the remote repository](/articles/adding-a-remote) where your local repository will be pushed. ```shell - $ git remote add origin remote_repository_URL + $ git remote add origin <REMOTE_URL> # Sets the new remote $ git remote -v # Verifies the new remote URL From f250954fda025f916d66227b93ad3dd722d450bd Mon Sep 17 00:00:00 2001 From: Martin Lopes Date: Wed, 20 Jan 2021 10:19:43 +1000 Subject: [PATCH 06/21] Added versioning for relative link --- .../creating-actions/creating-a-docker-container-action.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/actions/creating-actions/creating-a-docker-container-action.md b/content/actions/creating-actions/creating-a-docker-container-action.md index 11d350ebdc..daec06e7da 100644 --- a/content/actions/creating-actions/creating-a-docker-container-action.md +++ b/content/actions/creating-actions/creating-a-docker-container-action.md @@ -175,7 +175,7 @@ Now you're ready to test your action out in a workflow. When an action is in a p #### Example using a public action -The following workflow code uses the completed _hello world_ action in the public [`actions/hello-world-docker-action`](https://github.com/actions/hello-world-docker-action) repository. Copy the following workflow example code into a `.github/workflows/main.yml` file, but replace the `actions/hello-world-docker-action` with your repository and action name. You can also replace the `who-to-greet` input with your name. Public actions can be used even if they're not published to {% data variables.product.prodname_marketplace %}. For more information, see "[Publishing an action](/actions/creating-actions/publishing-actions-in-github-marketplace#publishing-an-action)." +The following workflow code uses the completed _hello world_ action in the public [`actions/hello-world-docker-action`](https://github.com/actions/hello-world-docker-action) repository. Copy the following workflow example code into a `.github/workflows/main.yml` file, but replace the `actions/hello-world-docker-action` with your repository and action name. You can also replace the `who-to-greet` input with your name. {% if currentVersion == "free-pro-team@latest" %}Public actions can be used even if they're not published to {% data variables.product.prodname_marketplace %}. For more information, see "[Publishing an action](/actions/creating-actions/publishing-actions-in-github-marketplace#publishing-an-action)." {% endif %} {% raw %} **.github/workflows/main.yml** From 87dbf0a19f89d9f177e42a831f8191dbf73c9f25 Mon Sep 17 00:00:00 2001 From: Amulya Raja <53104849+amulyaraja@users.noreply.github.com> Date: Tue, 19 Jan 2021 22:07:36 -0500 Subject: [PATCH 07/21] known issue about larger download size (#17340) also changed RC1 to say release candidates in general. Co-authored-by: Meg Bird --- data/release-notes/3-0/0-rc.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/data/release-notes/3-0/0-rc.yml b/data/release-notes/3-0/0-rc.yml index ab62dc23b1..d38b93195b 100644 --- a/data/release-notes/3-0/0-rc.yml +++ b/data/release-notes/3-0/0-rc.yml @@ -134,7 +134,8 @@ sections: - '`ghe-config-apply` occassionally fails with `ERROR: Failure waiting for nomad jobs to apply` until the Nomad job queue is cleared. This currently requires as admin to delete `/etc/nomad-jobs/queue`.' - When configuring a multiple replica node, the status of the replica can be incorrectly synchronized. - Customers attempting to restore a 3.0 backup to a new instance should not pre-configure the instance, as it may lead to a bad state for user logins. We recommend restoring to a fresh, unconfigured instance. - - GitHub Enterprise Server 3.0 release candidates are not yet available in the Azure marketplace. To test RC1 in staging environments, start a 2.21 or 2.22 instance, and then upgrade it with the Azure upgrade package on the download page. + - GitHub Enterprise Server 3.0 release candidates are not yet available in the Azure marketplace. To test release candidates in staging environments, start a 2.21 or 2.22 instance, and then upgrade it with the Azure upgrade package on the download page. + - The image and upgrade package download size has increased. Customers on slow internet connections may find the packages take longer to download. backups: - '{% data variables.product.prodname_ghe_server %} 3.0 requires at least [GitHub Enterprise Backup Utilities 3.0.0](https://github.com/github/backup-utils) for [Backups and Disaster Recovery](/enterprise-server@3.0/admin/configuration/configuring-backups-on-your-appliance).' From acc669a7eb88e00b541c58bc9b13c67de3779b4b Mon Sep 17 00:00:00 2001 From: Hal Wine <132412+hwine@users.noreply.github.com> Date: Tue, 19 Jan 2021 19:26:33 -0800 Subject: [PATCH 08/21] Update Actions billing wording (#2137) Co-authored-by: Lucas Costi --- data/reusables/github-actions/actions-billing.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data/reusables/github-actions/actions-billing.md b/data/reusables/github-actions/actions-billing.md index 4e12946e9b..249d4b339a 100644 --- a/data/reusables/github-actions/actions-billing.md +++ b/data/reusables/github-actions/actions-billing.md @@ -1 +1 @@ -{% data variables.product.prodname_actions %} usage is free for public repositories and self-hosted runners. For private repositories, each {% data variables.product.prodname_dotcom %} account receives a certain amount of free minutes and storage, depending on the product used with the account. Any usage beyond the included amounts is controlled by spending limits. +{% data variables.product.prodname_actions %} usage is free for both public repositories and self-hosted runners. For private repositories, each {% data variables.product.prodname_dotcom %} account receives a certain amount of free minutes and storage, depending on the product used with the account. Any usage beyond the included amounts is controlled by spending limits. From a0e3146b17fd24fa0640659a8e327bdf835a839a Mon Sep 17 00:00:00 2001 From: Martin Lopes Date: Wed, 20 Jan 2021 13:31:13 +1000 Subject: [PATCH 09/21] Added updates from peer review --- .../creating-a-docker-container-action.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/content/actions/creating-actions/creating-a-docker-container-action.md b/content/actions/creating-actions/creating-a-docker-container-action.md index daec06e7da..22da7d1e15 100644 --- a/content/actions/creating-actions/creating-a-docker-container-action.md +++ b/content/actions/creating-actions/creating-a-docker-container-action.md @@ -107,14 +107,13 @@ Next, the script gets the current time and sets it as an output variable that ac time=$(date) echo "::set-output name=time::$time" ``` + If `entrypoint.sh` executes without any errors, the action's status is set to `success`. You can also explicitly set exit codes in your action's code to provide an action's status. For more information, see "[Setting exit codes for actions](/actions/creating-actions/setting-exit-codes-for-actions)." -1. Make your `entrypoint.sh` file executable by running following command on your system: +1. Make your `entrypoint.sh` file executable by running the following command on your system. ```shell{:copy} - chmod +x entrypoint.sh + $ chmod +x entrypoint.sh ``` - - If `entrypoint.sh` executes without any errors, the action's status is set to `success`. You can also explicitly set exit codes in your action's code to provide an action's status. For more information, see "[Setting exit codes for actions](/actions/creating-actions/setting-exit-codes-for-actions)." ### Creating a README @@ -202,7 +201,7 @@ jobs: #### Example using a private action -Copy the following example workflow code into a `.github/workflows/main.yml` file in your action's repository. You can also replace the `who-to-greet` input with your name. This private action can't be published to {% data variables.product.prodname_marketplace %}, and can only be used in this repository. +Copy the following example workflow code into a `.github/workflows/main.yml` file in your action's repository. You can also replace the `who-to-greet` input with your name. {% if currentVersion == "free-pro-team@latest" %}This private action can't be published to {% data variables.product.prodname_marketplace %}, and can only be used in this repository.{% endif %} {% raw %} **.github/workflows/main.yml** From 9724f763f54a26938593fa8315d96246e580958a Mon Sep 17 00:00:00 2001 From: "James M. Greene" Date: Tue, 19 Jan 2021 23:00:54 -0600 Subject: [PATCH 10/21] Implement discount fingerprinting without webpack (#17337) --- includes/head.html | 2 +- includes/scripts.html | 2 +- layouts/dev-toc.html | 2 +- lib/built-asset-urls.js | 23 +++++++++++++++++++++++ middleware/context.js | 4 ++++ tests/rendering/server.js | 7 +++++-- 6 files changed, 35 insertions(+), 5 deletions(-) create mode 100644 lib/built-asset-urls.js diff --git a/includes/head.html b/includes/head.html index aae0ee2a4b..480c9cbc7d 100644 --- a/includes/head.html +++ b/includes/head.html @@ -23,7 +23,7 @@ /> {% endfor %} - + diff --git a/includes/scripts.html b/includes/scripts.html index 7c489813d5..1654d3dd35 100644 --- a/includes/scripts.html +++ b/includes/scripts.html @@ -1 +1 @@ - + diff --git a/layouts/dev-toc.html b/layouts/dev-toc.html index 59fe20ab5a..80c0900265 100644 --- a/layouts/dev-toc.html +++ b/layouts/dev-toc.html @@ -3,7 +3,7 @@ Docs TOC - + diff --git a/lib/built-asset-urls.js b/lib/built-asset-urls.js new file mode 100644 index 0000000000..ea2613a883 --- /dev/null +++ b/lib/built-asset-urls.js @@ -0,0 +1,23 @@ +const fs = require('fs') +const path = require('path') +const crypto = require('crypto') + +// Get an MD4 Digest Hex content hash, loosely based on Webpack `[contenthash]` +function getContentHash (absFilePath) { + const buffer = fs.readFileSync(absFilePath) + const hash = crypto.createHash('md4') + hash.update(buffer) + return hash.digest('hex') +} + +function getUrl (relFilePath) { + const absFilePath = path.join(process.cwd(), relFilePath) + return `/${relFilePath}?hash=${getContentHash(absFilePath)}` +} + +module.exports = { + main: { + js: getUrl('dist/index.js'), + css: getUrl('dist/index.css') + } +} diff --git a/middleware/context.js b/middleware/context.js index f5217852a9..3d24f94608 100644 --- a/middleware/context.js +++ b/middleware/context.js @@ -7,6 +7,7 @@ const { getVersionStringFromPath, getProductStringFromPath, getPathWithoutLangua const productNames = require('../lib/product-names') const warmServer = require('../lib/warm-server') const featureFlags = Object.keys(require('../feature-flags')) +const builtAssets = require('../lib/built-asset-urls') // Supply all route handlers with a baseline `req.context` object // Note that additional middleware in middleware/index.js adds to this context object @@ -42,5 +43,8 @@ module.exports = async function contextualize (req, res, next) { req.context.siteTree = siteTree req.context.pages = pageMap + // JS + CSS asset paths + req.context.builtAssets = builtAssets + return next() } diff --git a/tests/rendering/server.js b/tests/rendering/server.js index edb868218e..1228ecde66 100644 --- a/tests/rendering/server.js +++ b/tests/rendering/server.js @@ -4,6 +4,7 @@ const { get, getDOM, head } = require('../helpers/supertest') const { describeViaActionsOnly } = require('../helpers/conditional-runs') const path = require('path') const { loadPages } = require('../../lib/pages') +const builtAssets = require('../../lib/built-asset-urls') describe('server', () => { jest.setTimeout(60 * 1000) @@ -694,7 +695,8 @@ describe('?json query param for context debugging', () => { describe('stylesheets', () => { it('compiles and sets the right content-type header', async () => { - const res = await get('/dist/index.css') + const stylesheetUrl = builtAssets.main.css + const res = await get(stylesheetUrl) expect(res.statusCode).toBe(200) expect(res.headers['content-type']).toBe('text/css; charset=UTF-8') }) @@ -703,7 +705,8 @@ describe('stylesheets', () => { describe('client-side JavaScript bundle', () => { let res beforeAll(async (done) => { - res = await get('/dist/index.js') + const scriptUrl = builtAssets.main.js + res = await get(scriptUrl) done() }) From 831e440bea2910b6ab5f31aae4fc6dee056237b3 Mon Sep 17 00:00:00 2001 From: Martin Lopes Date: Wed, 20 Jan 2021 15:43:25 +1000 Subject: [PATCH 11/21] Update content/actions/creating-actions/creating-a-docker-container-action.md Co-authored-by: Lucas Costi --- .../creating-actions/creating-a-docker-container-action.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/content/actions/creating-actions/creating-a-docker-container-action.md b/content/actions/creating-actions/creating-a-docker-container-action.md index 22da7d1e15..b906f5358e 100644 --- a/content/actions/creating-actions/creating-a-docker-container-action.md +++ b/content/actions/creating-actions/creating-a-docker-container-action.md @@ -188,8 +188,6 @@ jobs: steps: - name: Hello world action step id: hello - # For unpublished actions put /@ - # For published actions put /@ uses: actions/hello-world-docker-action@v1 with: who-to-greet: 'Mona the Octocat' From 1c28c5867915a23c1220c9d3420c9c37f354dc1b Mon Sep 17 00:00:00 2001 From: hubwriter Date: Wed, 20 Jan 2021 09:19:36 +0000 Subject: [PATCH 12/21] Fix typo: unwanted full stop (#17374) * Remove full stop typo * Add a comma instead --- data/reusables/code-scanning/not-available.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data/reusables/code-scanning/not-available.md b/data/reusables/code-scanning/not-available.md index 6531f5e1d0..0e4d2ac82f 100644 --- a/data/reusables/code-scanning/not-available.md +++ b/data/reusables/code-scanning/not-available.md @@ -1,7 +1,7 @@ {% if currentVersion == "free-pro-team@latest" %} {% note %} -**Note:** For private and internal repositories, {% data variables.product.prodname_code_scanning %} is available when {% data variables.product.prodname_GH_advanced_security %} features are enabled for the repository. If you see the error `Advanced Security must be enabled for this repository to use code scanning.` check that {% data variables.product.prodname_GH_advanced_security %} is enabled. For more information, see "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)." +**Note:** For private and internal repositories, {% data variables.product.prodname_code_scanning %} is available when {% data variables.product.prodname_GH_advanced_security %} features are enabled for the repository. If you see the error `Advanced Security must be enabled for this repository to use code scanning`, check that {% data variables.product.prodname_GH_advanced_security %} is enabled. For more information, see "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)." {% endnote %} {% endif %} From 860d46bbf75f170d26be3ea4088e40ec0895a91e Mon Sep 17 00:00:00 2001 From: Felicity Chapman Date: Wed, 20 Jan 2021 11:56:30 +0000 Subject: [PATCH 13/21] Update lines 83 and 120 with the same change --- ...ng-an-existing-project-to-github-using-the-command-line.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/github/importing-your-projects-to-github/adding-an-existing-project-to-github-using-the-command-line.md b/content/github/importing-your-projects-to-github/adding-an-existing-project-to-github-using-the-command-line.md index 280c7ab4ab..d4d8512eee 100644 --- a/content/github/importing-your-projects-to-github/adding-an-existing-project-to-github-using-the-command-line.md +++ b/content/github/importing-your-projects-to-github/adding-an-existing-project-to-github-using-the-command-line.md @@ -80,7 +80,7 @@ versions: ![Copy remote repository URL field](/assets/images/help/repository/copy-remote-repository-url-quick-setup.png) 8. In the Command prompt, [add the URL for the remote repository](/articles/adding-a-remote) where your local repository will be pushed. ```shell - $ git remote add origin remote repository URL + $ git remote add origin <REMOTE_URL> # Sets the new remote $ git remote -v # Verifies the new remote URL @@ -117,7 +117,7 @@ versions: ![Copy remote repository URL field](/assets/images/help/repository/copy-remote-repository-url-quick-setup.png) 8. In Terminal, [add the URL for the remote repository](/articles/adding-a-remote) where your local repository will be pushed. ```shell - $ git remote add origin remote repository URL + $ git remote add origin <REMOTE_URL> # Sets the new remote $ git remote -v # Verifies the new remote URL From dc210512b95cb11f1b02b5c1f26cf666d6042f8e Mon Sep 17 00:00:00 2001 From: Vanessa Yuen <6842965+vanessayuenn@users.noreply.github.com> Date: Wed, 20 Jan 2021 14:47:12 +0100 Subject: [PATCH 14/21] build before algolia sync (#17378) * build project before syncing indicies * do the same for dry-run --- .github/workflows/dry-run-sync-algolia-search-indices.yml | 4 +++- .github/workflows/sync-algolia-search-indices.yml | 4 +++- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/.github/workflows/dry-run-sync-algolia-search-indices.yml b/.github/workflows/dry-run-sync-algolia-search-indices.yml index c11e986243..fe3d11e131 100644 --- a/.github/workflows/dry-run-sync-algolia-search-indices.yml +++ b/.github/workflows/dry-run-sync-algolia-search-indices.yml @@ -21,8 +21,10 @@ jobs: key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }} restore-keys: | ${{ runner.os }}-node- - - name: npm ci + - name: Install dependencies run: npm ci + - name: Run build scripts + run: npm run build - name: (Dry run) sync indices env: ALGOLIA_APPLICATION_ID: ${{ secrets.ALGOLIA_APPLICATION_ID }} diff --git a/.github/workflows/sync-algolia-search-indices.yml b/.github/workflows/sync-algolia-search-indices.yml index 512b3b0e0c..244d6394b1 100644 --- a/.github/workflows/sync-algolia-search-indices.yml +++ b/.github/workflows/sync-algolia-search-indices.yml @@ -24,8 +24,10 @@ jobs: key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }} restore-keys: | ${{ runner.os }}-node- - - name: npm ci + - name: Install dependencies run: npm ci + - name: Run build scripts + run: npm run build - name: sync indices env: ALGOLIA_APPLICATION_ID: ${{ secrets.ALGOLIA_APPLICATION_ID }} From c5c2347f0a0dda5f6a9b3a31dc9c0e7f1a45a30d Mon Sep 17 00:00:00 2001 From: "James M. Greene" Date: Wed, 20 Jan 2021 09:12:59 -0600 Subject: [PATCH 15/21] Prevent overly verbose broken link logging from linkinator (#17381) * Prevent overly verbose broken link logging from linkinator * Reduce unnecessary second 'map' call * Be VERY sure we aren't logging the failureDetails in case the linkinator implementation changes * Really smoosh that '.map' call down to size --- script/check-english-links.js | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/script/check-english-links.js b/script/check-english-links.js index e8be9c22ee..cfa2b5c7f0 100755 --- a/script/check-english-links.js +++ b/script/check-english-links.js @@ -67,6 +67,9 @@ async function main () { // Update CLI output and append to logfile after each checked link. checker.on('link', result => { + // We don't need to dump all of the HTTP and HTML details + delete result.failureDetails + fs.appendFileSync(logFile, JSON.stringify(result) + '\n') }) @@ -113,11 +116,7 @@ function displayBrokenLinks (brokenLinks) { const allStatusCodes = uniq(brokenLinks // Coerce undefined status codes into `Invalid` strings so we can display them. // Without this, undefined codes get JSON.stringified as `0`, which is not useful output. - .map(link => { - if (!link.status) link.status = 'Invalid' - return link - }) - .map(link => link.status) + .map(link => link.status || 'Invalid') ) allStatusCodes.forEach(statusCode => { @@ -126,6 +125,9 @@ function displayBrokenLinks (brokenLinks) { console.log(`## Status ${statusCode}: Found ${brokenLinksForStatus.length} broken links`) console.log('```') brokenLinksForStatus.forEach(brokenLinkObj => { + // We don't need to dump all of the HTTP and HTML details + delete brokenLinkObj.failureDetails + console.log(JSON.stringify(brokenLinkObj, null, 2)) }) console.log('```') From 2fb2e962bcdd6c9e95809127a6375f5d1141485d Mon Sep 17 00:00:00 2001 From: Kevin Heis Date: Wed, 20 Jan 2021 07:37:42 -0800 Subject: [PATCH 16/21] Move site search to use an endpoint (#17359) * Move site search to use an endpoint * Update browser.js * Update search.js * Update lib/search/versions.js Co-authored-by: James M. Greene * Fix URLs Co-authored-by: James M. Greene --- .gitignore | 1 + contributing/search.md | 10 +- includes/search-form.html | 8 +- javascripts/experiment.js | 18 +- javascripts/fake-hogan.js | 15 - javascripts/hyperscript.js | 44 ++ javascripts/search.js | 435 +++++++++--------- .../client.js => search/algolia-client.js} | 4 +- .../algolia-get-remote-index-names.js} | 7 +- .../algolia-search-index.js} | 56 +-- lib/{algolia => search}/build-records.js | 0 .../cached-index-names.json | 0 lib/search/config.js | 6 + .../find-indexable-pages.js | 0 .../parse-page-sections-into-records.js | 6 +- lib/{algolia => search}/rank.js | 0 lib/{algolia => search}/sync.js | 17 +- lib/search/validate-records.js | 47 ++ lib/search/versions.js | 13 + middleware/index.js | 1 + middleware/search.js | 57 +++ package.json | 3 +- script/check-deps.js | 1 - ...arch-indices.js => sync-search-indices.js} | 6 +- stylesheets/search.scss | 2 +- tests/browser/browser.js | 70 +-- tests/content/algolia-search.js | 8 +- .../parse-page-sections-into-records.js | 4 +- tests/unit/algolia/rank.js | 4 +- webpack.config.js | 9 +- 30 files changed, 436 insertions(+), 416 deletions(-) delete mode 100644 javascripts/fake-hogan.js create mode 100644 javascripts/hyperscript.js rename lib/{algolia/client.js => search/algolia-client.js} (59%) rename lib/{algolia/get-remote-index-names.js => search/algolia-get-remote-index-names.js} (60%) rename lib/{algolia/search-index.js => search/algolia-search-index.js} (59%) rename lib/{algolia => search}/build-records.js (100%) rename lib/{algolia => search}/cached-index-names.json (100%) create mode 100644 lib/search/config.js rename lib/{algolia => search}/find-indexable-pages.js (100%) rename lib/{algolia => search}/parse-page-sections-into-records.js (93%) rename lib/{algolia => search}/rank.js (100%) rename lib/{algolia => search}/sync.js (86%) create mode 100644 lib/search/validate-records.js create mode 100644 lib/search/versions.js create mode 100644 middleware/search.js rename script/{sync-algolia-search-indices.js => sync-search-indices.js} (59%) diff --git a/.gitignore b/.gitignore index 09bfb38e88..b98bdb2653 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,5 @@ .algolia-cache +.search-cache .DS_Store .env /node_modules/ diff --git a/contributing/search.md b/contributing/search.md index 4da0507ebf..589c377419 100644 --- a/contributing/search.md +++ b/contributing/search.md @@ -90,10 +90,10 @@ Why do we need this? For our daily shipping needs, it's tolerable that search up ### Code files -- [javascripts/search.js](javascripts/search.js) - The browser-side code that enables search using Algolia's [InstantSearch.js](https://github.com/algolia/instantsearch.js/) library. -- [lib/algolia/client.js](lib/algolia/client.js) - A thin wrapper around the [algoliasearch](https://ghub.io/algoliasearch) Node.js module for interacting with the Algolia API. -- [lib/algolia/search-index.js](lib/algolia/search-index.js) - A class for generating structured search data from repository content and syncing it with the remote Algolia service. This class has built-in validation to ensure that all records are valid before they're uploaded. This class also takes care of removing deprecated records, and compares existing remote records with the latest local records to avoid uploading records that haven't changed. -- [script/sync-algolia-search-indices.js](script/sync-algolia-search-indices.js) - The script used by the Actions workflow to update search indices on our Algolia account. This can also be [run in the development environment](#development). +- [javascripts/search.js](javascripts/search.js) - The browser-side code that enables search. +- [lib/search/algolia-client.js](lib/search/algolia-client.js) - A thin wrapper around the [algoliasearch](https://ghub.io/algoliasearch) Node.js module for interacting with the Algolia API. +- [lib/search/algolia-search-index.js](lib/search/algolia-search-index.js) - A class for generating structured search data from repository content and syncing it with the remote Algolia service. This class has built-in validation to ensure that all records are valid before they're uploaded. This class also takes care of removing deprecated records, and compares existing remote records with the latest local records to avoid uploading records that haven't changed. +- [script/sync-search-indices.js](script/sync-search-indices.js) - The script used by the Actions workflow to update search indices on our Algolia account. This can also be [run in the development environment](#development). - [tests/algolia-search.js](tests/algolia-search.js) - Tests! ## Indices @@ -136,4 +136,4 @@ Each record represents a section of a page. Sections are derived by splitting up - It's not strictly necessary to set an `objectID` as Algolia will create one automatically, but by creating our own we have a guarantee that subsequent invocations of this upload script will overwrite existing records instead of creating numerous duplicate records with differing IDs. - Algolia has typo tolerance. Try spelling something wrong and see what you get! - Algolia has lots of controls for customizing each index, so we can add weights to certain attributes and create rules like "title is more important than body", etc. But it works pretty well as-is without any configuration. -- Algolia has support for "advanced query syntax" for exact matching of quoted expressions and exclusion of words preceded by a `-` sign. This is off by default but we have it enabled in our browser client. This and many other settings can be configured in Algolia.com web interface. The settings in the web interface can be overridden by the InstantSearch.js client. See [javascripts/search.js]([javascripts/search.js). +- Algolia has support for "advanced query syntax" for exact matching of quoted expressions and exclusion of words preceded by a `-` sign. This is off by default but we have it enabled in our browser client. This and many other settings can be configured in Algolia.com web interface. The settings in the web interface can be overridden by the search endpoint. See [middleware/search.js]([middleware/search.js). diff --git a/includes/search-form.html b/includes/search-form.html index 34a2e48540..5749ba0803 100644 --- a/includes/search-form.html +++ b/includes/search-form.html @@ -5,8 +5,6 @@ - On all other pages, in the header --> - + diff --git a/javascripts/experiment.js b/javascripts/experiment.js index 200e718455..25e7660b44 100644 --- a/javascripts/experiment.js +++ b/javascripts/experiment.js @@ -1,5 +1,6 @@ import murmur from 'imurmurhash' import { getUserEventsId, sendEvent } from './events' +// import h from './hyperscript' const TREATMENT = 'TREATMENT' const CONTROL = 'CONTROL' @@ -19,23 +20,6 @@ export async function sendSuccess (test) { }) } -const xmlns = 'http://www.w3.org/2000/svg' - -export function h (tagName, attributes = {}, children = []) { - const el = ['svg', 'path'].includes(tagName) - ? document.createElementNS(xmlns, tagName) - : document.createElement(tagName) - Object.entries(attributes).forEach( - ([key, value]) => el.setAttribute(key, value) - ) - children.forEach(child => - typeof child === 'string' - ? el.append(document.createTextNode(child)) - : el.append(child) - ) - return el -} - export default function () { // const testName = '$test-name$' // const xbucket = bucket(testName) diff --git a/javascripts/fake-hogan.js b/javascripts/fake-hogan.js deleted file mode 100644 index 1846a52f38..0000000000 --- a/javascripts/fake-hogan.js +++ /dev/null @@ -1,15 +0,0 @@ -// This module overrides "Hogan" that instantsearch.js uses -// Hogan uses `new Function`, -// so we can't use it with our content security policy. -// Turns out, we use all our own templates anyway, -// so we just have to shim out Hogan so it doesn't error! - -export default { - compile (template) { - return { - render (data) { - return '' - } - } - } -} diff --git a/javascripts/hyperscript.js b/javascripts/hyperscript.js new file mode 100644 index 0000000000..7c09d2e33e --- /dev/null +++ b/javascripts/hyperscript.js @@ -0,0 +1,44 @@ +const xmlns = 'http://www.w3.org/2000/svg' + +const plainObjectConstructor = {}.constructor + +function exists (value) { + return value !== null && typeof value !== 'undefined' +} + +function isPlainObject (value) { + return value.constructor === plainObjectConstructor +} + +function isString (value) { + return typeof value === 'string' +} + +function renderChildren (el, children) { + for (const child of children) { + if (isPlainObject(child)) { + Object.entries(child) + .filter(([key, value]) => exists(value)) + .forEach(([key, value]) => el.setAttribute(key, value)) + } else if (Array.isArray(child)) { + renderChildren(el, child) + } else if (isString(child)) { + el.append(document.createTextNode(child)) + } else { + el.append(child) + } + } +} + +export default function h (tagName, ...children) { + const el = ['svg', 'path'].includes(tagName) + ? document.createElementNS(xmlns, tagName) + : document.createElement(tagName) + renderChildren(el, children) + return el +} + +export const tags = Object.fromEntries( + ['div', 'form', 'a', 'input', 'button', 'ol', 'li', 'em'] + .map(tagName => [tagName, (...args) => h(tagName, ...args)]) +) diff --git a/javascripts/search.js b/javascripts/search.js index 2e68ffdbd9..607dd1f91a 100644 --- a/javascripts/search.js +++ b/javascripts/search.js @@ -1,9 +1,6 @@ +import { tags } from './hyperscript' import { sendEvent } from './events' -const instantsearch = require('instantsearch.js').default -const { searchBox, hits, configure, analytics } = require('instantsearch.js/es/widgets') -const algoliasearch = require('algoliasearch') const searchWithYourKeyboard = require('search-with-your-keyboard') -const querystring = require('querystring') const truncate = require('html-truncate') const languages = require('../lib/languages') const allVersions = require('../lib/all-versions') @@ -12,261 +9,96 @@ const nonEnterpriseDefaultVersion = require('../lib/non-enterprise-default-versi const languageCodes = Object.keys(languages) const maxContentLength = 300 -const hasStandaloneSearch = () => document.getElementById('landing') || document.querySelector('body.error-404') !== null +let $searchInputContainer +let $searchResultsContainer +let $searchOverlay +let $searchInput -const resultTemplate = (item) => { - // Attach an `algolia-query` param to each result link so analytics - // can track the search query that led the user to this result - const input = document.querySelector('#search-input-container input') - if (input) { - const url = new URL(item.objectID, window.location.origin) - const queryParams = new URLSearchParams(url.search.slice(1)) - queryParams.append('algolia-query', input.value) - url.search = queryParams.toString() - item.modifiedURL = url.toString() - } +let placeholder = 'Search topics, products...' +let version +let language - // Display page title and heading (if present exists) - const title = item._highlightResult.heading - ? [item._highlightResult.title.value, item._highlightResult.heading.value].join(': ') - : item._highlightResult.title.value +export default function search () { + $searchInputContainer = document.getElementById('search-input-container') + $searchResultsContainer = document.getElementById('search-results-container') - // Remove redundant title from the end of breadcrumbs - if (item.breadcrumbs && item.breadcrumbs.endsWith(item.title)) { - item.modifiedBreadcrumbs = item.breadcrumbs.replace(' / ' + item.title, '') - } else { - item.modifiedBreadcrumbs = item.breadcrumbs - } + if (!$searchInputContainer || !$searchResultsContainer) return - // Truncate and ellipsize the content string without breaking any HTML - // within it, such as the tags added by Algolia for emphasis. - item.modifiedContent = truncate(item._highlightResult.content.value, maxContentLength) + $searchOverlay = document.querySelector('.search-overlay-desktop') - // Construct the template to return - const html = ` - - ` - - // Sanitize the link's href attribute using the DOM API to prevent XSS - const fragment = document.createRange().createContextualFragment(html) - fragment.querySelector('a').setAttribute('href', item.modifiedURL) - const div = document.createElement('div') - div.appendChild(fragment.cloneNode(true)) - - return div.innerHTML -} - -export default function () { - if (!document.querySelector('#search-results-container')) return - - window.initialPageLoad = true - const opts = { - - // https://www.algolia.com/apps/ZI5KPY1HBE/dashboard - // This API key is public. There's also a private API key for writing to the Algolia API - searchClient: algoliasearch('ZI5KPY1HBE', '685df617246c3a10abba589b4599288f'), - - // There's an index for every version/language combination - indexName: `github-docs-${deriveVersionFromPath()}-${deriveLanguageCodeFromPath()}`, - - // allows "phrase queries" and "prohibit operator" - // https://www.algolia.com/doc/api-reference/api-parameters/advancedSyntax/ - advancedSyntax: true, - - // sync query params to search input - routing: true, - - searchFunction: helper => { - // console.log('searchFunction', helper.state) - const query = helper.state.query - const queryPresent = query && query.length > 0 - const results = document.querySelector('.ais-Hits') - // avoid conducting an empty search on page load; - if (window.initialPageLoad && !queryPresent) return - - // after page load, search should be executed (even if the query is empty) - // so as not to upset the default instantsearch.js behaviors like clearing - // the input when [x] is clicked. - helper.search() - - // If on homepage, toggle results container if query is present - if (hasStandaloneSearch()) { - const container = document.getElementById('search-results-container') - // Primer classNames for showing and hiding the results container - const activeClass = container.getAttribute('data-active-class') - const inactiveClass = container.getAttribute('data-inactive-class') - - if (!activeClass) { - console.error('container is missing required `data-active-class` attribute', container) - return - } - - if (!inactiveClass) { - console.error('container is missing required `data-inactive-class` attribute', container) - return - } - - // hide the container when no query is present - container.classList.toggle(activeClass, queryPresent) - container.classList.toggle(inactiveClass, !queryPresent) - } - - // Hack to work around a mysterious bug where the input is not cleared - // when the [x] is clicked. Note: this bug only occurs on pages - // loaded with a ?query=foo param already present - if (!queryPresent) { - setTimeout(() => { - document.querySelector('#search-input-container input').value = '' - }, 50) - results.style.display = 'none' - } - - if (queryPresent && results) results.style.display = 'block' - window.initialPageLoad = false - toggleSearchDisplay() - } - } - - const search = instantsearch(opts) + // There's an index for every version/language combination + version = deriveVersionFromPath() + language = deriveLanguageCodeFromPath() // Find search placeholder text in a tag, falling back to a default - const placeholderMeta = document.querySelector('meta[name="site.data.ui.search.placeholder"]') - const placeholder = placeholderMeta ? placeholderMeta.content : 'Search topics, products...' + const $placeholderMeta = document.querySelector('meta[name="site.data.ui.search.placeholder"]') + if ($placeholderMeta) { + placeholder = $placeholderMeta.content + } - search.addWidgets( - [ - hits({ - container: '#search-results-container', - templates: { - empty: 'No results', - item: resultTemplate - }, - // useful for debugging template context, if needed - transformItems: items => { - // console.log(`transformItems`, items) - return items - } - }), - configure({ - analyticsTags: [ - 'site:docs.github.com', - `env:${process.env.NODE_ENV}` - ] - }), - searchBox({ - container: '#search-input-container', - placeholder, - // only autofocus on the homepage, and only if no #hash is present in the URL - autofocus: (hasStandaloneSearch()) && !window.location.hash.length, - showReset: false, - showSubmit: false - }), - analytics({ - pushFunction (params, state, results) { - sendEvent({ - type: 'search', - search_query: results.query - // search_context - }) - } - }) - ] - ) + $searchInputContainer.append(tmplSearchInput()) + $searchInput = $searchInputContainer.querySelector('input') - // enable for debugging - search.on('render', (...args) => { - // console.log(`algolia render`, args) - }) - - search.on('error', (...args) => { - console.error('algolia error', args) - }) - - search.start() searchWithYourKeyboard('#search-input-container input', '.ais-Hits-item') toggleSearchDisplay() - // delay removal of the query param so analytics client code has a chance to track it - setTimeout(() => { removeAlgoliaQueryTrackingParam() }, 500) + $searchInput.addEventListener('keyup', debounce(onSearch)) } -// When a user performs an in-site search an `algolia-query` param is -// added to the URL so analytics can track the queries and the pages -// they lead to. This function strips the query from the URL after page load, -// so the bare article URL can be copied/bookmarked/shared, sans tracking param -function removeAlgoliaQueryTrackingParam () { - if ( - history && - history.replaceState && - location && - location.search && - location.search.includes('algolia-query=') - ) { - // parse the query string, remove the `algolia-query`, and put it all back together - let q = querystring.parse(location.search.replace(/^\?/, '')) - delete q['algolia-query'] - q = Object.keys(q).length ? '?' + querystring.stringify(q) : '' - - // update the URL in the address bar without modifying the history - history.replaceState(null, '', `${location.pathname}${q}${location.hash}`) - } +// The home page and 404 pages have a standalone search +function hasStandaloneSearch () { + return document.getElementById('landing') || + document.querySelector('body.error-404') !== null } -function toggleSearchDisplay (isReset) { - const input = document.querySelector('#search-input-container input') - const overlay = document.querySelector('.search-overlay-desktop') - - // If not on homepage... - if (!hasStandaloneSearch()) { - // Open modal if input is clicked - input.addEventListener('focus', () => { - openSearch() - }) - - // Close modal if overlay is clicked - if (overlay) { - overlay.addEventListener('click', () => { - closeSearch() - }) - } - - // Open modal if page loads with query in the params/input - if (input.value) { - openSearch() - } - } - +function toggleSearchDisplay () { // Clear/close search, if ESC is clicked document.addEventListener('keyup', (e) => { if (e.key === 'Escape') { closeSearch() } }) + + // If not on homepage... + if (hasStandaloneSearch()) return + + const $input = $searchInput + + // Open modal if input is clicked + $input.addEventListener('focus', () => { + openSearch() + }) + + // Close modal if overlay is clicked + if ($searchOverlay) { + $searchOverlay.addEventListener('click', () => { + closeSearch() + }) + } + + // Open modal if page loads with query in the params/input + if ($input.value) { + openSearch() + } } function openSearch () { - document.querySelector('#search-input-container input').classList.add('js-open') - document.querySelector('#search-results-container').classList.add('js-open') - document.querySelector('.search-overlay-desktop').classList.add('js-open') + $searchInput.classList.add('js-open') + $searchResultsContainer.classList.add('js-open') + $searchOverlay.classList.add('js-open') } function closeSearch () { // Close modal if not on homepage if (!hasStandaloneSearch()) { - document.querySelector('#search-input-container input').classList.remove('js-open') - document.querySelector('#search-results-container').classList.remove('js-open') - document.querySelector('.search-overlay-desktop').classList.remove('js-open') + $searchInput.classList.remove('js-open') + $searchResultsContainer.classList.remove('js-open') + $searchOverlay.classList.remove('js-open') } - document.querySelector('.ais-Hits').style.display = 'none' - document.querySelector('#search-input-container input').value = '' - window.history.replaceState({}, 'clear search query', window.location.pathname) + const $hits = $searchResultsContainer.querySelector('.ais-Hits') + if ($hits) $hits.style.display = 'none' + $searchInput.value = '' } function deriveLanguageCodeFromPath () { @@ -277,8 +109,8 @@ function deriveLanguageCodeFromPath () { function deriveVersionFromPath () { // fall back to the non-enterprise default version (FPT currently) on the homepage, 404 page, etc. - const version = location.pathname.split('/')[2] || nonEnterpriseDefaultVersion - const versionObject = allVersions[version] || allVersions[nonEnterpriseDefaultVersion] + const versionStr = location.pathname.split('/')[2] || nonEnterpriseDefaultVersion + const versionObject = allVersions[versionStr] || allVersions[nonEnterpriseDefaultVersion] // if GHES, returns the release number like 2.21, 2.22, etc. // if FPT, returns 'dotcom' @@ -287,3 +119,148 @@ function deriveVersionFromPath () { ? versionObject.currentRelease : versionObject.miscBaseName } + +function debounce (fn, delay = 300) { + let timer + return (...args) => { + clearTimeout(timer) + timer = setTimeout(() => fn.apply(null, args), delay) + } +} + +async function onSearch (evt) { + const query = evt.target.value + + const url = new URL(location.origin) + url.pathname = '/search' + url.search = new URLSearchParams({ query, version, language }).toString() + + const response = await fetch(url, { + method: 'GET', + headers: { + 'Content-Type': 'application/json' + } + }) + const results = response.ok ? await response.json() : [] + + $searchResultsContainer.querySelectorAll('*').forEach(el => el.remove()) + $searchResultsContainer.append( + tmplSearchResults(results) + ) + + toggleStandaloneSearch() + + // Analytics tracking + sendEvent({ + type: 'search', + search_query: query + // search_context + }) +} + +// If on homepage, toggle results container if query is present +function toggleStandaloneSearch () { + if (!hasStandaloneSearch()) return + + const query = $searchInput.value + const queryPresent = query && query.length > 0 + const $results = document.querySelector('.ais-Hits') + + // Primer classNames for showing and hiding the results container + const activeClass = $searchResultsContainer.getAttribute('data-active-class') + const inactiveClass = $searchResultsContainer.getAttribute('data-inactive-class') + + if (!activeClass) { + console.error('container is missing required `data-active-class` attribute', $searchResultsContainer) + return + } + + if (!inactiveClass) { + console.error('container is missing required `data-inactive-class` attribute', $searchResultsContainer) + return + } + + // hide the container when no query is present + $searchResultsContainer.classList.toggle(activeClass, queryPresent) + $searchResultsContainer.classList.toggle(inactiveClass, !queryPresent) + + if (queryPresent && $results) $results.style.display = 'block' +} + +/** * Template functions ***/ + +function tmplSearchInput () { + // only autofocus on the homepage, and only if no #hash is present in the URL + const autofocus = (hasStandaloneSearch() && !location.hash.length) || null + const { div, form, input, button } = tags + return div( + { class: 'ais-SearchBox' }, + form( + { role: 'search', class: 'ais-SearchBox-form', novalidate: true }, + input({ + class: 'ais-SearchBox-input', + type: 'search', + placeholder, + autofocus, + autocomplete: 'off', + autocorrect: 'off', + autocapitalize: 'off', + spellcheck: 'false', + maxlength: '512' + }), + button({ + class: 'ais-SearchBox-submit', + type: 'submit', + title: 'Submit the search query.', + hidden: true + }) + ) + ) +} + +function tmplSearchResults (items) { + const { div, ol, li } = tags + return div( + { class: 'ais-Hits', style: 'display:block' }, + ol( + { class: 'ais-Hits-list' }, + items.map(item => li( + { class: 'ais-Hits-item' }, + tmplSearchResult(item) + )) + ) + ) +} + +function tmplSearchResult ({ url, breadcrumbs, heading, title, content }) { + const { div, a } = tags + return div( + { class: 'search-result border-top border-gray-light py-3 px-2' }, + a( + { href: url, class: 'no-underline' }, + div( + { class: 'search-result-breadcrumbs d-block text-gray-dark opacity-60 text-small pb-1' }, + // Remove redundant title from the end of breadcrumbs + emify((breadcrumbs || '').replace(` / ${title}`, '')) + ), + div( + { class: 'search-result-title d-block h4-mktg text-gray-dark' }, + // Display page title and heading (if present exists) + emify(heading ? `${title}: ${heading}` : title) + ), + div( + { class: 'search-result-content d-block text-gray' }, + // Truncate without breaking inner HTML tags + emify(truncate(content, maxContentLength)) + ) + ) + ) +} + +// Allow em tags in search responses +function emify (text) { + const { em } = tags + return text + .split(/<\/?em>/g) + .map((el, i) => i % 2 ? em(el) : el) +} diff --git a/lib/algolia/client.js b/lib/search/algolia-client.js similarity index 59% rename from lib/algolia/client.js rename to lib/search/algolia-client.js index 16fdb7daea..dc1f54636b 100644 --- a/lib/algolia/client.js +++ b/lib/search/algolia-client.js @@ -3,4 +3,6 @@ require('dotenv').config() const algoliasearch = require('algoliasearch') const { ALGOLIA_APPLICATION_ID, ALGOLIA_API_KEY } = process.env -module.exports = algoliasearch(ALGOLIA_APPLICATION_ID, ALGOLIA_API_KEY) +module.exports = function () { + return algoliasearch(ALGOLIA_APPLICATION_ID, ALGOLIA_API_KEY) +} diff --git a/lib/algolia/get-remote-index-names.js b/lib/search/algolia-get-remote-index-names.js similarity index 60% rename from lib/algolia/get-remote-index-names.js rename to lib/search/algolia-get-remote-index-names.js index d7cad539d1..fb8334ce14 100644 --- a/lib/algolia/get-remote-index-names.js +++ b/lib/search/algolia-get-remote-index-names.js @@ -1,13 +1,14 @@ -const algoliaClient = require('./client') -const AlgoliaIndex = require('./search-index') +const { namePrefix } = require('./config') +const getAlgoliaClient = require('./algolia-client') module.exports = async function getRemoteIndexNames () { + const algoliaClient = getAlgoliaClient() const indices = await algoliaClient.listIndexes() // ignore other indices that may be present in the Algolia account like `helphub-`, etc const indexNames = indices.items .map(field => field.name) - .filter(name => name.startsWith(AlgoliaIndex.namePrefix)) + .filter(name => name.startsWith(namePrefix)) return indexNames } diff --git a/lib/algolia/search-index.js b/lib/search/algolia-search-index.js similarity index 59% rename from lib/algolia/search-index.js rename to lib/search/algolia-search-index.js index dcf119764c..1e43e71ea3 100644 --- a/lib/algolia/search-index.js +++ b/lib/search/algolia-search-index.js @@ -1,17 +1,11 @@ -const assert = require('assert') -const { chain, chunk, difference, isArray, isString, inRange } = require('lodash') +const { chain, chunk, difference } = require('lodash') const eventToPromise = require('event-to-promise') const objectHash = require('object-hash') -const countArrayValues = require('count-array-values') -const isURL = require('is-url') const rank = require('./rank') +const validateRecords = require('./validate-records') +const getAlgoliaClient = require('./algolia-client') class AlgoliaIndex { - // records must be truncated to avoid going over Algolia's 10K limit - static get maxRecordLength () { return 8000 } - static get maxContentLength () { return 5000 } - static get namePrefix () { return 'github-docs' } - constructor (name, records) { this.name = name this.records = records @@ -24,52 +18,14 @@ class AlgoliaIndex { } validate () { - assert(isString(this.name) && this.name.length, '`name` is required') - assert(isArray(this.records) && this.records.length, '`records` must be a non-empty array') - - // each ID is unique - const objectIDs = this.records.map(record => record.objectID) - const dupes = countArrayValues(objectIDs) - .filter(({ value, count }) => count > 1) - .map(({ value }) => value) - assert(!dupes.length, `every objectID must be unique. dupes: ${dupes.join('; ')}`) - - this.records.forEach(record => { - assert( - isString(record.objectID) && record.objectID.length, - `objectID must be a string. received: ${record.objectID}, ${JSON.stringify(record)}` - ) - - assert( - isString(record.title) && record.title.length, - `title must be a string. received: ${record.title}, ${JSON.stringify(record)}` - ) - - assert( - isURL(record.url), - `url must be a fully qualified URL. received: ${record.url}, ${JSON.stringify(record)}` - ) - - assert( - inRange(record.customRanking, 0, 4), - `customRanking must be an in-range number. received: ${record.customRanking}, (record: ${record.url})` - ) - - const recordLength = JSON.stringify(record).length - assert( - recordLength <= AlgoliaIndex.maxRecordLength, - `record ${record.url} is too long! ${recordLength} (max: ${AlgoliaIndex.maxRecordLength})` - ) - }) - - return true + return validateRecords(this.name, this.records) } // This method consumes Algolia's `browseAll` event emitter, // aggregating results into an array of all the records // https://www.algolia.com/doc/api-reference/api-methods/browse/ async fetchExistingRecords () { - const client = require('./client') + const client = getAlgoliaClient() // return an empty array if the index does not exist yet const { items: indices } = await client.listIndexes() @@ -97,7 +53,7 @@ class AlgoliaIndex { } async syncWithRemote () { - const client = require('./client') + const client = getAlgoliaClient() console.log('\n\nsyncing %s with remote', this.name) this.validate() diff --git a/lib/algolia/build-records.js b/lib/search/build-records.js similarity index 100% rename from lib/algolia/build-records.js rename to lib/search/build-records.js diff --git a/lib/algolia/cached-index-names.json b/lib/search/cached-index-names.json similarity index 100% rename from lib/algolia/cached-index-names.json rename to lib/search/cached-index-names.json diff --git a/lib/search/config.js b/lib/search/config.js new file mode 100644 index 0000000000..5c54d0e3c0 --- /dev/null +++ b/lib/search/config.js @@ -0,0 +1,6 @@ +module.exports = { + // records must be truncated to avoid going over Algolia's 10K limit + maxRecordLength: 8000, + maxContentLength: 5000, + namePrefix: 'github-docs' +} diff --git a/lib/algolia/find-indexable-pages.js b/lib/search/find-indexable-pages.js similarity index 100% rename from lib/algolia/find-indexable-pages.js rename to lib/search/find-indexable-pages.js diff --git a/lib/algolia/parse-page-sections-into-records.js b/lib/search/parse-page-sections-into-records.js similarity index 93% rename from lib/algolia/parse-page-sections-into-records.js rename to lib/search/parse-page-sections-into-records.js index dbd15ad2ba..79ac651f83 100644 --- a/lib/algolia/parse-page-sections-into-records.js +++ b/lib/search/parse-page-sections-into-records.js @@ -4,11 +4,11 @@ const { chain } = require('lodash') const urlPrefix = 'https://docs.github.com' -const AlgoliaIndex = require('./search-index') const ignoredHeadingSlugs = [ 'in-this-article', 'further-reading' ] +const { maxContentLength } = require('./config') module.exports = function parsePageSectionsIntoRecords (href, $) { const title = $('h1').text().trim() @@ -46,7 +46,7 @@ module.exports = function parsePageSectionsIntoRecords (href, $) { .get() .join(' ') .trim() - .slice(0, AlgoliaIndex.maxContentLength) + .slice(0, maxContentLength) return { objectID, url, @@ -67,7 +67,7 @@ module.exports = function parsePageSectionsIntoRecords (href, $) { .get() .join(' ') .trim() - .slice(0, AlgoliaIndex.maxContentLength) + .slice(0, maxContentLength) records = [{ objectID, diff --git a/lib/algolia/rank.js b/lib/search/rank.js similarity index 100% rename from lib/algolia/rank.js rename to lib/search/rank.js diff --git a/lib/algolia/sync.js b/lib/search/sync.js similarity index 86% rename from lib/algolia/sync.js rename to lib/search/sync.js index c7d6bf43cc..fa6e03428f 100644 --- a/lib/algolia/sync.js +++ b/lib/search/sync.js @@ -6,14 +6,17 @@ const chalk = require('chalk') const languages = require('../languages') const buildRecords = require('./build-records') const findIndexablePages = require('./find-indexable-pages') -const getRemoteIndexNames = require('./get-remote-index-names') -const Index = require('./search-index') -const cacheDir = path.join(process.cwd(), './.algolia-cache') +const cacheDir = path.join(process.cwd(), './.search-cache') const allVersions = require('../all-versions') +const { namePrefix } = require('./config') + +// Algolia +const getRemoteIndexNames = require('./algolia-get-remote-index-names') +const AlgoliaIndex = require('./algolia-search-index') // Build a search data file for every combination of product version and language // e.g. `github-docs-dotcom-en.json` and `github-docs-2.14-ja.json` -module.exports = async function syncAlgoliaIndices (opts = {}) { +module.exports = async function syncSearchIndexes (opts = {}) { if (opts.dryRun) { console.log('This is a dry run! The script will build the indices locally but not upload anything.\n') rimraf(cacheDir) @@ -60,11 +63,11 @@ module.exports = async function syncAlgoliaIndices (opts = {}) { : allVersions[pageVersion].miscBaseName // github-docs-dotcom-en, github-docs-2.22-en - const indexName = `${Index.namePrefix}-${indexVersion}-${languageCode}` + const indexName = `${namePrefix}-${indexVersion}-${languageCode}` // The page version will be the new version, e.g., free-pro-team@latest, enterprise-server@2.22 const records = await buildRecords(indexName, indexablePages, pageVersion, languageCode) - const index = new Index(indexName, records) + const index = new AlgoliaIndex(indexName, records) if (opts.dryRun) { const cacheFile = path.join(cacheDir, `${indexName}.json`) @@ -87,7 +90,7 @@ module.exports = async function syncAlgoliaIndices (opts = {}) { ) if (!process.env.CI) { - console.log(chalk.green(`\nCached remote index names in ${path.relative(process.cwd(), cachedIndexNamesFile)}`)) + console.log(chalk.green(`\nCached index names in ${path.relative(process.cwd(), cachedIndexNamesFile)}`)) console.log(chalk.green('(If this file has any changes, please commit them)')) } diff --git a/lib/search/validate-records.js b/lib/search/validate-records.js new file mode 100644 index 0000000000..fbbd4b09cd --- /dev/null +++ b/lib/search/validate-records.js @@ -0,0 +1,47 @@ +const assert = require('assert') +const { isArray, isString, inRange } = require('lodash') +const isURL = require('is-url') +const countArrayValues = require('count-array-values') +const { maxRecordLength } = require('./config') + +module.exports = function validateRecords (name, records) { + assert(isString(name) && name.length, '`name` is required') + assert(isArray(records) && records.length, '`records` must be a non-empty array') + + // each ID is unique + const objectIDs = records.map(record => record.objectID) + const dupes = countArrayValues(objectIDs) + .filter(({ value, count }) => count > 1) + .map(({ value }) => value) + assert(!dupes.length, `every objectID must be unique. dupes: ${dupes.join('; ')}`) + + records.forEach(record => { + assert( + isString(record.objectID) && record.objectID.length, + `objectID must be a string. received: ${record.objectID}, ${JSON.stringify(record)}` + ) + + assert( + isString(record.title) && record.title.length, + `title must be a string. received: ${record.title}, ${JSON.stringify(record)}` + ) + + assert( + isURL(record.url), + `url must be a fully qualified URL. received: ${record.url}, ${JSON.stringify(record)}` + ) + + assert( + inRange(record.customRanking, 0, 4), + `customRanking must be an in-range number. received: ${record.customRanking}, (record: ${record.url})` + ) + + const recordLength = JSON.stringify(record).length + assert( + recordLength <= maxRecordLength, + `record ${record.url} is too long! ${recordLength} (max: ${maxRecordLength})` + ) + }) + + return true +} diff --git a/lib/search/versions.js b/lib/search/versions.js new file mode 100644 index 0000000000..479e2b7d18 --- /dev/null +++ b/lib/search/versions.js @@ -0,0 +1,13 @@ +const allVersions = require('../all-versions') + +module.exports = new Set( + Object.values(allVersions) + .map(version => + // if GHES, resolves to the release number like 2.21, 2.22, etc. + // if FPT, resolves to 'dotcom' + // if GHAE, resolves to 'ghae' + version.plan === 'enterprise-server' + ? version.currentRelease + : version.miscBaseName + ) +) diff --git a/middleware/index.js b/middleware/index.js index ce02a3d347..4eead804ec 100644 --- a/middleware/index.js +++ b/middleware/index.js @@ -66,6 +66,7 @@ module.exports = function (app) { app.use('/public', express.static('data/graphql')) app.use('/events', require('./events')) app.use('/csrf', require('./csrf-route')) + app.use('/search', require('./search')) app.use(require('./archived-enterprise-versions')) app.use(require('./robots')) app.use(/(\/.*)?\/early-access$/, require('./contextualizers/early-access-links')) diff --git a/middleware/search.js b/middleware/search.js new file mode 100644 index 0000000000..262d4216df --- /dev/null +++ b/middleware/search.js @@ -0,0 +1,57 @@ +const express = require('express') +const algoliasearch = require('algoliasearch') +const { namePrefix } = require('../lib/search/config') +const languages = new Set(Object.keys(require('../lib/languages'))) +const versions = require('../lib/search/versions') + +const router = express.Router() + +// https://www.algolia.com/apps/ZI5KPY1HBE/dashboard +// This API key is public. There's also a private API key for writing to the Algolia API +const searchClient = algoliasearch('ZI5KPY1HBE', '685df617246c3a10abba589b4599288f') + +async function loadAlgoliaResults ({ version, language, query, limit }) { + const indexName = `${namePrefix}-${version}-${language}` + const index = searchClient.initIndex(indexName) + + // allows "phrase queries" and "prohibit operator" + // https://www.algolia.com/doc/api-reference/api-parameters/advancedSyntax/ + const { hits } = await index.search(query, { + hitsPerPage: limit, + advancedSyntax: true + }) + + return hits.map(hit => ({ + url: hit.url, + breadcrumbs: hit._highlightResult.breadcrumbs.value, + heading: hit._highlightResult.heading.value, + title: hit._highlightResult.title.value, + content: hit._highlightResult.content.value + })) +} + +router.get('/', async (req, res) => { + res.set({ + 'surrogate-control': 'private, no-store', + 'cache-control': 'private, no-store' + }) + + const { query, version, language } = req.query + const limit = Math.min(parseInt(req.query.limit, 10) || 10, 100) + if (!versions.has(version) || !languages.has(language)) { + return res.status(400).json([]) + } + if (!query || !limit) { + return res.status(200).json([]) + } + + try { + const results = await loadAlgoliaResults({ version, language, query, limit }) + return res.status(200).json(results) + } catch (err) { + console.error(err) + return res.status(400).json([]) + } +}) + +module.exports = router diff --git a/package.json b/package.json index e61d744f15..9634afcf35 100644 --- a/package.json +++ b/package.json @@ -57,7 +57,6 @@ "html-truncate": "^1.2.2", "hubdown": "^2.6.0", "imurmurhash": "^0.1.4", - "instantsearch.js": "^4.8.2", "ioredis": "^4.19.4", "ioredis-mock": "^5.2.0", "is-url": "^1.2.4", @@ -166,7 +165,7 @@ "sync-search": "start-server-and-test sync-search-server 4002 sync-search-indices", "sync-search-dry-run": "DRY_RUN=1 npm run sync-search", "sync-search-server": "cross-env NODE_ENV=production PORT=4002 node server.js", - "sync-search-indices": "script/sync-algolia-search-indices.js", + "sync-search-indices": "script/sync-search-indices.js", "test-watch": "jest --watch --notify --notifyMode=change --coverage", "check-deps": "node script/check-deps.js", "prevent-pushes-to-main": "node script/prevent-pushes-to-main.js", diff --git a/script/check-deps.js b/script/check-deps.js index 946bc82a3d..c5da72b5dc 100644 --- a/script/check-deps.js +++ b/script/check-deps.js @@ -32,7 +32,6 @@ const main = async () => { '@babel/*', 'babel-preset-env', '@primer/*', - 'instantsearch.js', 'querystring', 'pa11y-ci', 'sass', diff --git a/script/sync-algolia-search-indices.js b/script/sync-search-indices.js similarity index 59% rename from script/sync-algolia-search-indices.js rename to script/sync-search-indices.js index 105e0defa3..047c2a25fd 100755 --- a/script/sync-algolia-search-indices.js +++ b/script/sync-search-indices.js @@ -2,8 +2,8 @@ // [start-readme] // -// This script is run automatically via GitHub Actions on every push to `master` to generate searchable data -// and upload it to our Algolia account. It can also be run manually. For more info see [contributing/search.md](contributing/search.md) +// This script is run automatically via GitHub Actions on every push to `main` to generate searchable data. +// It can also be run manually. For more info see [contributing/search.md](contributing/search.md) // // [end-readme] @@ -12,7 +12,7 @@ require('make-promises-safe') main() async function main () { - const sync = require('../lib/algolia/sync') + const sync = require('../lib/search/sync') const opts = { dryRun: 'DRY_RUN' in process.env, language: process.env.LANGUAGE, diff --git a/stylesheets/search.scss b/stylesheets/search.scss index 7bbfcb9f35..2364bb139c 100644 --- a/stylesheets/search.scss +++ b/stylesheets/search.scss @@ -3,7 +3,7 @@ /* Global styles Gets applied to both the search input on homepage and in the header nav -Form and inputs using .ais- prefix gets added by Algolia InstantSearch.js */ +Form and inputs using .ais- prefix gets added by search.js */ .ais-SearchBox { position: relative; } diff --git a/tests/browser/browser.js b/tests/browser/browser.js index 956b52f216..9f98e1f10a 100644 --- a/tests/browser/browser.js +++ b/tests/browser/browser.js @@ -42,84 +42,45 @@ describe('algolia browser search', () => { }) it('sends the correct data to algolia for Enterprise Server', async () => { - expect.assertions(12) // 3 assertions x 4 letters ('test') + expect.assertions(2) const newPage = await browser.newPage() await newPage.goto('http://localhost:4001/ja/enterprise/2.22/admin/installation') await newPage.setRequestInterception(true) newPage.on('request', interceptedRequest => { - if (interceptedRequest.method() === 'POST' && /algolia/i.test(interceptedRequest.url())) { - const data = JSON.parse(interceptedRequest.postData()) - const { indexName, params } = data.requests[0] - const parsedParams = querystring.parse(params) - const analyticsTags = JSON.parse(parsedParams.analyticsTags) - expect(indexName).toBe('github-docs-2.22-ja') - expect(analyticsTags).toHaveLength(2) - // browser tests are run against production build, so we are expecting env:production - expect(analyticsTags).toEqual(expect.arrayContaining(['site:docs.github.com', 'env:production'])) + if (interceptedRequest.method() === 'GET' && /search/i.test(interceptedRequest.url())) { + const { version, language } = querystring.parse(interceptedRequest.url()) + expect(version).toBe('2.22') + expect(language).toBe('ja') } interceptedRequest.continue() }) await newPage.click('#search-input-container input[type="search"]') await newPage.type('#search-input-container input[type="search"]', 'test') + await newPage.waitForSelector('.search-result') }) it('sends the correct data to algolia for GHAE', async () => { - expect.assertions(12) // 3 assertions x 4 letters ('test') + expect.assertions(2) const newPage = await browser.newPage() await newPage.goto('http://localhost:4001/en/github-ae@latest/admin/overview') await newPage.setRequestInterception(true) newPage.on('request', interceptedRequest => { - if (interceptedRequest.method() === 'POST' && /algolia/i.test(interceptedRequest.url())) { - const data = JSON.parse(interceptedRequest.postData()) - const { indexName, params } = data.requests[0] - const parsedParams = querystring.parse(params) - const analyticsTags = JSON.parse(parsedParams.analyticsTags) - expect(indexName).toBe('github-docs-ghae-en') - expect(analyticsTags).toHaveLength(2) - // browser tests are run against production build, so we are expecting env:production - expect(analyticsTags).toEqual(expect.arrayContaining(['site:docs.github.com', 'env:production'])) + if (interceptedRequest.method() === 'GET' && /search/i.test(interceptedRequest.url())) { + const { version, language } = querystring.parse(interceptedRequest.url()) + expect(version).toBe('ghae') + expect(language).toBe('en') } interceptedRequest.continue() }) await newPage.click('#search-input-container input[type="search"]') await newPage.type('#search-input-container input[type="search"]', 'test') - }) - - it('removes `algolia-query` query param after page load', async () => { - await page.goto('http://localhost:4001/en?algolia-query=helpme') - - // check that the query is still present at page load - let location = await getLocationObject(page) - expect(location.search).toBe('?algolia-query=helpme') - - // query removal is in a setInterval, so wait a bit - await sleep(1000) - - // check that the query has been removed after a bit - location = await getLocationObject(page) - expect(location.search).toBe('') - }) - - it('does not remove hash when removing `algolia-query` query', async () => { - await page.goto('http://localhost:4001/en?algolia-query=helpme#some-header') - - // check that the query is still present at page load - let location = await getLocationObject(page) - expect(location.search).toBe('?algolia-query=helpme') - - // query removal is in a setInterval, so wait a bit - await sleep(1000) - - // check that the query has been removed after a bit - location = await getLocationObject(page) - expect(location.search).toBe('') - expect(location.hash).toBe('#some-header') + await newPage.waitForSelector('.search-result') }) }) @@ -166,13 +127,6 @@ describe('csrf meta', () => { }) }) -async function getLocationObject (page) { - const location = await page.evaluate(() => { - return Promise.resolve(JSON.stringify(window.location, null, 2)) - }) - return JSON.parse(location) -} - describe('platform specific content', () => { // from tests/javascripts/user-agent.js const userAgents = [ diff --git a/tests/content/algolia-search.js b/tests/content/algolia-search.js index 75e3d5c8a8..32989f5035 100644 --- a/tests/content/algolia-search.js +++ b/tests/content/algolia-search.js @@ -1,14 +1,14 @@ const { dates, supported } = require('../../lib/enterprise-server-releases') const languageCodes = Object.keys(require('../../lib/languages')) -const AlgoliaIndex = require('../../lib/algolia/search-index') -const remoteIndexNames = require('../../lib/algolia/cached-index-names.json') +const { namePrefix } = require('../../lib/search/config') +const remoteIndexNames = require('../../lib/search/cached-index-names.json') describe('algolia', () => { test('has remote indexNames in every language for every supported GHE version', () => { expect(supported.length).toBeGreaterThan(1) supported.forEach(version => { languageCodes.forEach(languageCode => { - const indexName = `${AlgoliaIndex.namePrefix}-${version}-${languageCode}` + const indexName = `${namePrefix}-${version}-${languageCode}` // workaround for GHES release branches not in production yet if (!remoteIndexNames.includes(indexName)) { @@ -28,7 +28,7 @@ describe('algolia', () => { test('has remote indexNames in every language for dotcom', async () => { expect(languageCodes.length).toBeGreaterThan(0) languageCodes.forEach(languageCode => { - const indexName = `${AlgoliaIndex.namePrefix}-dotcom-${languageCode}` + const indexName = `${namePrefix}-dotcom-${languageCode}` expect(remoteIndexNames.includes(indexName)).toBe(true) }) }) diff --git a/tests/unit/algolia/parse-page-sections-into-records.js b/tests/unit/algolia/parse-page-sections-into-records.js index 0137185b2c..e328f846f0 100644 --- a/tests/unit/algolia/parse-page-sections-into-records.js +++ b/tests/unit/algolia/parse-page-sections-into-records.js @@ -1,13 +1,13 @@ const fs = require('fs') const path = require('path') const cheerio = require('cheerio') -const parsePageSectionsIntoRecords = require('../../../lib/algolia/parse-page-sections-into-records') +const parsePageSectionsIntoRecords = require('../../../lib/search/parse-page-sections-into-records') const fixtures = { pageWithSections: fs.readFileSync(path.join(__dirname, 'fixtures/page-with-sections.html'), 'utf8'), pageWithoutSections: fs.readFileSync(path.join(__dirname, 'fixtures/page-without-sections.html'), 'utf8') } -describe('algolia parsePageSectionsIntoRecords module', () => { +describe('search parsePageSectionsIntoRecords module', () => { test('works for pages with sections', () => { const html = fixtures.pageWithSections const $ = cheerio.load(html) diff --git a/tests/unit/algolia/rank.js b/tests/unit/algolia/rank.js index e9557ce589..c1ba1b80a3 100644 --- a/tests/unit/algolia/rank.js +++ b/tests/unit/algolia/rank.js @@ -1,6 +1,6 @@ -const rank = require('../../../lib/algolia/rank') +const rank = require('../../../lib/search/rank') -test('algolia custom rankings', () => { +test('search custom rankings', () => { const expectedRankings = [ ['https://docs.github.com/en/github/actions', 3], ['https://docs.github.com/en/rest/reference', 2], diff --git a/webpack.config.js b/webpack.config.js index 91ca6d7ab6..74c804125d 100644 --- a/webpack.config.js +++ b/webpack.config.js @@ -86,12 +86,5 @@ module.exports = { ] }), new EnvironmentPlugin(['NODE_ENV']) - ], - resolve: { - alias: { - // Hogan uses `new Function` which breaks content security policy - // Turns out, we aren't even using it anyways! - 'hogan.js': path.resolve(__dirname, 'javascripts/fake-hogan.js') - } - } + ] } From d15514cb77b3a998578e6d80f0eabbf0a15dde31 Mon Sep 17 00:00:00 2001 From: github-openapi-bot <69533958+github-openapi-bot@users.noreply.github.com> Date: Wed, 20 Jan 2021 10:56:48 -0500 Subject: [PATCH 17/21] Update OpenAPI Descriptions --- lib/rest/static/decorated/api.github.com.json | 231 +- lib/rest/static/decorated/ghes-2.18.json | 42 +- lib/rest/static/decorated/ghes-2.19.json | 42 +- lib/rest/static/decorated/ghes-2.20.json | 42 +- lib/rest/static/decorated/ghes-2.21.json | 50 +- lib/rest/static/decorated/ghes-2.22.json | 54 +- lib/rest/static/decorated/ghes-3.0.json | 54 +- lib/rest/static/decorated/github.ae.json | 54 +- .../dereferenced/api.github.com.deref.json | 4539 ++++++----------- .../static/dereferenced/ghes-2.18.deref.json | 4068 ++++----------- .../static/dereferenced/ghes-2.19.deref.json | 4068 ++++----------- .../static/dereferenced/ghes-2.20.deref.json | 4068 ++++----------- .../static/dereferenced/ghes-2.21.deref.json | 4072 ++++----------- .../static/dereferenced/ghes-2.22.deref.json | 4074 ++++----------- .../static/dereferenced/ghes-3.0.deref.json | 4074 ++++----------- .../static/dereferenced/github.ae.deref.json | 4074 ++++----------- 16 files changed, 8518 insertions(+), 25088 deletions(-) diff --git a/lib/rest/static/decorated/api.github.com.json b/lib/rest/static/decorated/api.github.com.json index 04e165da07..dd442f6d32 100644 --- a/lib/rest/static/decorated/api.github.com.json +++ b/lib/rest/static/decorated/api.github.com.json @@ -11123,7 +11123,7 @@ "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Default response", - "payload": "
[\n  {\n    \"url\": \"https://api.github.com/gists/dee9c42e4998ce2ea439\",\n    \"id\": \"dee9c42e4998ce2ea439\",\n    \"created_at\": \"2011-04-14T16:00:49Z\",\n    \"updated_at\": \"2011-04-14T16:00:49Z\"\n  }\n]\n
" + "payload": "
[\n  {\n    \"url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d\",\n    \"forks_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\n    \"commits_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\n    \"id\": \"aa5a315d61ae9438b18d\",\n    \"node_id\": \"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\n    \"git_pull_url\": \"https://gist.github.com/aa5a315d61ae9438b18d.git\",\n    \"git_push_url\": \"https://gist.github.com/aa5a315d61ae9438b18d.git\",\n    \"html_url\": \"https://gist.github.com/aa5a315d61ae9438b18d\",\n    \"files\": {\n      \"hello_world.rb\": {\n        \"filename\": \"hello_world.rb\",\n        \"type\": \"application/x-ruby\",\n        \"language\": \"Ruby\",\n        \"raw_url\": \"https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb\",\n        \"size\": 167\n      }\n    },\n    \"public\": true,\n    \"created_at\": \"2010-04-14T02:15:15Z\",\n    \"updated_at\": \"2011-06-20T11:34:15Z\",\n    \"description\": \"Hello World Examples\",\n    \"comments\": 1,\n    \"user\": null,\n    \"comments_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\",\n    \"owner\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    }\n  }\n]\n
" }, { "httpStatusCode": "304", @@ -18186,6 +18186,92 @@ "bodyParameters": [], "descriptionHTML": "" }, + { + "verb": "get", + "requestPath": "/orgs/{org}/failed_invitations", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "per_page", + "description": "Results per page (max 100)", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "descriptionHTML": "

Results per page (max 100)

" + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "descriptionHTML": "

Page number of the results to fetch.

" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/failed_invitations", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/failed_invitations
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /orgs/{org}/failed_invitations', {\n org: 'org'\n})", + "html": "
await octokit.request('GET /orgs/{org}/failed_invitations', {\n  org: 'org'\n})\n
" + } + ], + "summary": "List failed organization invitations", + "description": "The return hash contains `failed_at` and `failed_reason` fields which represent the time at which the invitation failed and the reason for the failure.", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-failed-invitations", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/orgs#list-failed-organization-invitations" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "orgs", + "subcategory": "members" + }, + "slug": "list-failed-organization-invitations", + "category": "orgs", + "categoryLabel": "Orgs", + "subcategory": "members", + "subcategoryLabel": "Members", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

The return hash contains failed_at and failed_reason fields which represent the time at which the invitation failed and the reason for the failure.

", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
[\n  {\n    \"id\": 1,\n    \"login\": \"monalisa\",\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"email\": \"octocat@github.com\",\n    \"role\": \"direct_member\",\n    \"created_at\": \"2016-11-30T06:46:10-08:00\",\n    \"failed_at\": \"\",\n    \"failed_reason\": \"\",\n    \"inviter\": {\n      \"login\": \"other_user\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/other_user_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/other_user\",\n      \"html_url\": \"https://github.com/other_user\",\n      \"followers_url\": \"https://api.github.com/users/other_user/followers\",\n      \"following_url\": \"https://api.github.com/users/other_user/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/other_user/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/other_user/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/other_user/orgs\",\n      \"repos_url\": \"https://api.github.com/users/other_user/repos\",\n      \"events_url\": \"https://api.github.com/users/other_user/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/other_user/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"team_count\": 2,\n    \"invitation_team_url\": \"https://api.github.com/organizations/2/invitations/1/teams\"\n  }\n]\n
" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + } + ] + }, { "verb": "get", "requestPath": "/orgs/{org}/hooks", @@ -20039,7 +20125,7 @@ "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Default response", - "payload": "
[\n  {\n    \"id\": 1,\n    \"login\": \"monalisa\",\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"email\": \"octocat@github.com\",\n    \"role\": \"direct_member\",\n    \"created_at\": \"2016-11-30T06:46:10-08:00\",\n    \"inviter\": {\n      \"login\": \"other_user\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/other_user_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/other_user\",\n      \"html_url\": \"https://github.com/other_user\",\n      \"followers_url\": \"https://api.github.com/users/other_user/followers\",\n      \"following_url\": \"https://api.github.com/users/other_user/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/other_user/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/other_user/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/other_user/orgs\",\n      \"repos_url\": \"https://api.github.com/users/other_user/repos\",\n      \"events_url\": \"https://api.github.com/users/other_user/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/other_user/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"team_count\": 2,\n    \"invitation_team_url\": \"https://api.github.com/organizations/2/invitations/1/teams\"\n  }\n]\n
" + "payload": "
[\n  {\n    \"id\": 1,\n    \"login\": \"monalisa\",\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"email\": \"octocat@github.com\",\n    \"role\": \"direct_member\",\n    \"created_at\": \"2016-11-30T06:46:10-08:00\",\n    \"failed_at\": \"\",\n    \"failed_reason\": \"\",\n    \"inviter\": {\n      \"login\": \"other_user\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/other_user_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/other_user\",\n      \"html_url\": \"https://github.com/other_user\",\n      \"followers_url\": \"https://api.github.com/users/other_user/followers\",\n      \"following_url\": \"https://api.github.com/users/other_user/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/other_user/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/other_user/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/other_user/orgs\",\n      \"repos_url\": \"https://api.github.com/users/other_user/repos\",\n      \"events_url\": \"https://api.github.com/users/other_user/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/other_user/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"team_count\": 2,\n    \"invitation_team_url\": \"https://api.github.com/organizations/2/invitations/1/teams\"\n  }\n]\n
" }, { "httpStatusCode": "404", @@ -20076,7 +20162,7 @@ } ], "summary": "Create an organization invitation", - "description": "Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner.\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.", + "description": "Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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": [ "orgs" ], @@ -20163,7 +20249,7 @@ "subcategory": "members", "subcategoryLabel": "Members", "notes": [], - "descriptionHTML": "

Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", + "descriptionHTML": "

Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", "bodyParameters": [ { "type": "integer", @@ -20230,6 +20316,87 @@ } ] }, + { + "verb": "delete", + "requestPath": "/orgs/{org}/invitations/{invitation_id}", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "invitation_id", + "description": "invitation_id parameter", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

invitation_id parameter

" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/invitations/42", + "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/invitations/42
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('DELETE /orgs/{org}/invitations/{invitation_id}', {\n org: 'org',\n invitation_id: 42\n})", + "html": "
await octokit.request('DELETE /orgs/{org}/invitations/{invitation_id}', {\n  org: 'org',\n  invitation_id: 42\n})\n
" + } + ], + "summary": "Cancel an organization invitation", + "description": "Cancel an organization invitation. In order to cancel an organization invitation, the authenticated user must be an organization owner.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications).", + "tags": [ + "orgs" + ], + "operationId": "orgs/cancel-invitation", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/orgs#cancel-an-organization-invitation" + }, + "x-github": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "orgs", + "subcategory": "members" + }, + "slug": "cancel-an-organization-invitation", + "category": "orgs", + "categoryLabel": "Orgs", + "subcategory": "members", + "subcategoryLabel": "Members", + "notes": [], + "responses": [ + { + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Default Response" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + } + ], + "bodyParameters": [], + "descriptionHTML": "

Cancel an organization invitation. In order to cancel an organization invitation, the authenticated user must be an organization owner.

\n

This endpoint triggers notifications.

" + }, { "verb": "get", "requestPath": "/orgs/{org}/invitations/{invitation_id}/teams", @@ -24263,7 +24430,7 @@ } ], "summary": "Create a discussion", - "description": "Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\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**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`.", + "description": "Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`.", "tags": [ "teams" ], @@ -24340,7 +24507,7 @@ "subcategory": "discussions", "subcategoryLabel": "Discussions", "notes": [], - "descriptionHTML": "

Creates a new discussion post on a team's page. OAuth access tokens require the write:discussion scope.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

\n

Note: You can also specify a team by org_id and team_id using the route POST /organizations/{org_id}/team/{team_id}/discussions.

", + "descriptionHTML": "

Creates a new discussion post on a team's page. OAuth access tokens require the write:discussion scope.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

\n

Note: You can also specify a team by org_id and team_id using the route POST /organizations/{org_id}/team/{team_id}/discussions.

", "bodyParameters": [ { "type": "string", @@ -24853,7 +25020,7 @@ } ], "summary": "Create a discussion comment", - "description": "Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\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**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.", + "description": "Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.", "tags": [ "teams" ], @@ -24909,7 +25076,7 @@ "subcategory": "discussion-comments", "subcategoryLabel": "Discussion comments", "notes": [], - "descriptionHTML": "

Creates a new comment on a team discussion. OAuth access tokens require the write:discussion scope.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

\n

Note: You can also specify a team by org_id and team_id using the route POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments.

", + "descriptionHTML": "

Creates a new comment on a team discussion. OAuth access tokens require the write:discussion scope.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

\n

Note: You can also specify a team by org_id and team_id using the route POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments.

", "bodyParameters": [ { "type": "string", @@ -26078,7 +26245,7 @@ "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Default response", - "payload": "
[\n  {\n    \"id\": 1,\n    \"login\": \"monalisa\",\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"email\": \"octocat@github.com\",\n    \"role\": \"direct_member\",\n    \"created_at\": \"2016-11-30T06:46:10-08:00\",\n    \"inviter\": {\n      \"login\": \"other_user\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/other_user_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/other_user\",\n      \"html_url\": \"https://github.com/other_user\",\n      \"followers_url\": \"https://api.github.com/users/other_user/followers\",\n      \"following_url\": \"https://api.github.com/users/other_user/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/other_user/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/other_user/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/other_user/orgs\",\n      \"repos_url\": \"https://api.github.com/users/other_user/repos\",\n      \"events_url\": \"https://api.github.com/users/other_user/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/other_user/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"team_count\": 2,\n    \"invitation_team_url\": \"https://api.github.com/organizations/2/invitations/1/teams\"\n  }\n]\n
" + "payload": "
[\n  {\n    \"id\": 1,\n    \"login\": \"monalisa\",\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"email\": \"octocat@github.com\",\n    \"role\": \"direct_member\",\n    \"created_at\": \"2016-11-30T06:46:10-08:00\",\n    \"failed_at\": \"\",\n    \"failed_reason\": \"\",\n    \"inviter\": {\n      \"login\": \"other_user\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/other_user_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/other_user\",\n      \"html_url\": \"https://github.com/other_user\",\n      \"followers_url\": \"https://api.github.com/users/other_user/followers\",\n      \"following_url\": \"https://api.github.com/users/other_user/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/other_user/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/other_user/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/other_user/orgs\",\n      \"repos_url\": \"https://api.github.com/users/other_user/repos\",\n      \"events_url\": \"https://api.github.com/users/other_user/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/other_user/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"team_count\": 2,\n    \"invitation_team_url\": \"https://api.github.com/organizations/2/invitations/1/teams\"\n  }\n]\n
" } ] }, @@ -45094,7 +45261,7 @@ } ], "summary": "Add a repository collaborator", - "description": "This 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\nFor more information the permission levels, see \"[Repository permission levels for an organization](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs).\"\n\nThe invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [repository invitations API endpoints](https://docs.github.com/rest/reference/repos#invitations).\n\n**Rate limits**\n\nTo prevent abuse, you are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.", + "description": "This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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\nFor more information the permission levels, see \"[Repository permission levels for an organization](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs).\"\n\nThe invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [repository invitations API endpoints](https://docs.github.com/rest/reference/repos#invitations).\n\n**Rate limits**\n\nTo prevent abuse, you are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.", "tags": [ "repos" ], @@ -45154,7 +45321,7 @@ "subcategory": "collaborators", "subcategoryLabel": "Collaborators", "notes": [], - "descriptionHTML": "

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

\n

For more information the permission levels, see \"Repository permission levels for an organization\".

\n

Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"

\n

The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the repository invitations API endpoints.

\n

Rate limits

\n

To prevent abuse, you are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.

", + "descriptionHTML": "

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

\n

For more information the permission levels, see \"Repository permission levels for an organization\".

\n

Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"

\n

The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the repository invitations API endpoints.

\n

Rate limits

\n

To prevent abuse, you are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.

", "bodyParameters": [ { "type": "string", @@ -46559,7 +46726,7 @@ } ], "summary": "Create a commit comment", - "description": "Create a comment for a commit using its `:commit_sha`.\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.", + "description": "Create a comment for a commit using its `:commit_sha`.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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": [ "repos" ], @@ -46638,7 +46805,7 @@ "subcategory": "comments", "subcategoryLabel": "Comments", "notes": [], - "descriptionHTML": "

Create a comment for a commit using its :commit_sha.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", + "descriptionHTML": "

Create a comment for a commit using its :commit_sha.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", "bodyParameters": [ { "type": "string", @@ -56184,7 +56351,7 @@ } ], "summary": "Create an issue", - "description": "Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://help.github.com/articles/disabling-issues/), the API returns a `410 Gone` status.\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-abuse-rate-limits)\" for details.", + "description": "Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://help.github.com/articles/disabling-issues/), the API returns a `410 Gone` status.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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-abuse-rate-limits)\" for details.", "tags": [ "issues" ], @@ -56313,7 +56480,7 @@ "category": "issues", "categoryLabel": "Issues", "notes": [], - "descriptionHTML": "

Any user with pull access to a repository can create an issue. If issues are disabled in the repository, the API returns a 410 Gone status.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", + "descriptionHTML": "

Any user with pull access to a repository can create an issue. If issues are disabled in the repository, the API returns a 410 Gone status.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", "bodyParameters": [ { "type": "string", @@ -58304,7 +58471,7 @@ } ], "summary": "Create an issue comment", - "description": "This 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-abuse-rate-limits)\" for details.", + "description": "This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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-abuse-rate-limits)\" for details.", "tags": [ "issues" ], @@ -58353,7 +58520,7 @@ "subcategory": "comments", "subcategoryLabel": "Comments", "notes": [], - "descriptionHTML": "

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", + "descriptionHTML": "

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", "bodyParameters": [ { "type": "string", @@ -63493,7 +63660,7 @@ } ], "summary": "Create a pull request", - "description": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.\n\nYou can create a new pull request.\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.", + "description": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.\n\nYou can create a new pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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" ], @@ -63598,7 +63765,7 @@ "category": "pulls", "categoryLabel": "Pulls", "notes": [], - "descriptionHTML": "

Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

\n

To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.

\n

You can create a new pull request.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", + "descriptionHTML": "

Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

\n

To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.

\n

You can create a new pull request.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", "bodyParameters": [ { "type": "string", @@ -65007,7 +65174,7 @@ } ], "summary": "Create a review comment for a pull request", - "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.", + "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://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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" ], @@ -65166,7 +65333,7 @@ "subcategory": "comments", "subcategoryLabel": "Comments", "notes": [], - "descriptionHTML": "

Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"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

You 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.

\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

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", + "descriptionHTML": "

Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"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

You 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.

\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

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", "bodyParameters": [ { "type": "string", @@ -65334,7 +65501,7 @@ } ], "summary": "Create a reply for a review comment", - "description": "Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported.\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.", + "description": "Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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" ], @@ -65383,7 +65550,7 @@ "subcategory": "comments", "subcategoryLabel": "Comments", "notes": [], - "descriptionHTML": "

Creates a reply to a review comment for a pull request. For the comment_id, provide the ID of the review comment you are replying to. This must be the ID of a top-level review comment, not a reply to that comment. Replies to replies are not supported.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", + "descriptionHTML": "

Creates a reply to a review comment for a pull request. For the comment_id, provide the ID of the review comment you are replying to. This must be the ID of a top-level review comment, not a reply to that comment. Replies to replies are not supported.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", "bodyParameters": [ { "type": "string", @@ -66450,7 +66617,7 @@ } ], "summary": "Create a review for a pull request", - "description": "This 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\nPull request reviews created in the `PENDING` state do not include the `submitted_at` property in the response.\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API v3 offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/rest/reference/pulls#get-a-pull-request) endpoint.\n\nThe `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.", + "description": "This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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\nPull request reviews created in the `PENDING` state do not include the `submitted_at` property in the response.\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API v3 offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/rest/reference/pulls#get-a-pull-request) endpoint.\n\nThe `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.", "tags": [ "pulls" ], @@ -66680,7 +66847,7 @@ "subcategory": "reviews", "subcategoryLabel": "Reviews", "notes": [], - "descriptionHTML": "

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

\n

Pull request reviews created in the PENDING state do not include the submitted_at property in the response.

\n

Note: To comment on a specific line in a file, you need to first determine the position of that line in the diff. The GitHub REST API v3 offers the application/vnd.github.v3.diff media type. To see a pull request diff, add this media type to the Accept header of a call to the single pull request endpoint.

\n

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.

", + "descriptionHTML": "

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

\n

Pull request reviews created in the PENDING state do not include the submitted_at property in the response.

\n

Note: To comment on a specific line in a file, you need to first determine the position of that line in the diff. The GitHub REST API v3 offers the application/vnd.github.v3.diff media type. To see a pull request diff, add this media type to the Accept header of a call to the single pull request endpoint.

\n

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.

", "responses": [ { "httpStatusCode": "200", @@ -67992,7 +68159,7 @@ } ], "summary": "Create a release", - "description": "Users with push access to the repository can create a release.\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.", + "description": "Users with push access to the repository can create a release.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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": [ "repos" ], @@ -68093,7 +68260,7 @@ "subcategory": "releases", "subcategoryLabel": "Releases", "notes": [], - "descriptionHTML": "

Users with push access to the repository can create a release.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", + "descriptionHTML": "

Users with push access to the repository can create a release.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", "bodyParameters": [ { "type": "string", @@ -77485,7 +77652,7 @@ } ], "summary": "Create a discussion (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/reference/teams#create-a-discussion) endpoint.\n\nCreates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\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.", + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/reference/teams#create-a-discussion) endpoint.\n\nCreates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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": [ "teams" ], @@ -77565,7 +77732,7 @@ "subcategory": "discussions", "subcategoryLabel": "Discussions", "notes": [], - "descriptionHTML": "

Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create a discussion endpoint.

\n

Creates a new discussion post on a team's page. OAuth access tokens require the write:discussion scope.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", + "descriptionHTML": "

Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create a discussion endpoint.

\n

Creates a new discussion post on a team's page. OAuth access tokens require the write:discussion scope.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", "bodyParameters": [ { "type": "string", @@ -78040,7 +78207,7 @@ } ], "summary": "Create a discussion comment (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/reference/teams#create-a-discussion-comment) endpoint.\n\nCreates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\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.", + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/reference/teams#create-a-discussion-comment) endpoint.\n\nCreates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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": [ "teams" ], @@ -78099,7 +78266,7 @@ "subcategory": "discussion-comments", "subcategoryLabel": "Discussion comments", "notes": [], - "descriptionHTML": "

Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create a discussion comment endpoint.

\n

Creates a new comment on a team discussion. OAuth access tokens require the write:discussion scope.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", + "descriptionHTML": "

Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create a discussion comment endpoint.

\n

Creates a new comment on a team discussion. OAuth access tokens require the write:discussion scope.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", "bodyParameters": [ { "type": "string", @@ -79017,7 +79184,7 @@ "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Default response", - "payload": "
[\n  {\n    \"id\": 1,\n    \"login\": \"monalisa\",\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"email\": \"octocat@github.com\",\n    \"role\": \"direct_member\",\n    \"created_at\": \"2016-11-30T06:46:10-08:00\",\n    \"inviter\": {\n      \"login\": \"other_user\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/other_user_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/other_user\",\n      \"html_url\": \"https://github.com/other_user\",\n      \"followers_url\": \"https://api.github.com/users/other_user/followers\",\n      \"following_url\": \"https://api.github.com/users/other_user/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/other_user/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/other_user/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/other_user/orgs\",\n      \"repos_url\": \"https://api.github.com/users/other_user/repos\",\n      \"events_url\": \"https://api.github.com/users/other_user/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/other_user/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"team_count\": 2,\n    \"invitation_team_url\": \"https://api.github.com/organizations/2/invitations/1/teams\"\n  }\n]\n
" + "payload": "
[\n  {\n    \"id\": 1,\n    \"login\": \"monalisa\",\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"email\": \"octocat@github.com\",\n    \"role\": \"direct_member\",\n    \"created_at\": \"2016-11-30T06:46:10-08:00\",\n    \"failed_at\": \"\",\n    \"failed_reason\": \"\",\n    \"inviter\": {\n      \"login\": \"other_user\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/other_user_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/other_user\",\n      \"html_url\": \"https://github.com/other_user\",\n      \"followers_url\": \"https://api.github.com/users/other_user/followers\",\n      \"following_url\": \"https://api.github.com/users/other_user/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/other_user/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/other_user/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/other_user/orgs\",\n      \"repos_url\": \"https://api.github.com/users/other_user/repos\",\n      \"events_url\": \"https://api.github.com/users/other_user/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/other_user/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"team_count\": 2,\n    \"invitation_team_url\": \"https://api.github.com/organizations/2/invitations/1/teams\"\n  }\n]\n
" } ] }, diff --git a/lib/rest/static/decorated/ghes-2.18.json b/lib/rest/static/decorated/ghes-2.18.json index e4ea1ab87d..70ab6c5e1b 100644 --- a/lib/rest/static/decorated/ghes-2.18.json +++ b/lib/rest/static/decorated/ghes-2.18.json @@ -9429,7 +9429,7 @@ "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Default response", - "payload": "
[\n  {\n    \"url\": \"https://api.github.com/gists/dee9c42e4998ce2ea439\",\n    \"id\": \"dee9c42e4998ce2ea439\",\n    \"created_at\": \"2011-04-14T16:00:49Z\",\n    \"updated_at\": \"2011-04-14T16:00:49Z\"\n  }\n]\n
" + "payload": "
[\n  {\n    \"url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d\",\n    \"forks_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\n    \"commits_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\n    \"id\": \"aa5a315d61ae9438b18d\",\n    \"node_id\": \"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\n    \"git_pull_url\": \"https://gist.github.com/aa5a315d61ae9438b18d.git\",\n    \"git_push_url\": \"https://gist.github.com/aa5a315d61ae9438b18d.git\",\n    \"html_url\": \"https://gist.github.com/aa5a315d61ae9438b18d\",\n    \"files\": {\n      \"hello_world.rb\": {\n        \"filename\": \"hello_world.rb\",\n        \"type\": \"application/x-ruby\",\n        \"language\": \"Ruby\",\n        \"raw_url\": \"https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb\",\n        \"size\": 167\n      }\n    },\n    \"public\": true,\n    \"created_at\": \"2010-04-14T02:15:15Z\",\n    \"updated_at\": \"2011-06-20T11:34:15Z\",\n    \"description\": \"Hello World Examples\",\n    \"comments\": 1,\n    \"user\": null,\n    \"comments_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\",\n    \"owner\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    }\n  }\n]\n
" }, { "httpStatusCode": "304", @@ -28921,7 +28921,7 @@ } ], "summary": "Add a repository collaborator", - "description": "This 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.18/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\nFor more information the permission levels, see \"[Repository permission levels for an organization](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#http-verbs).\"\n\nThe invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [repository invitations API endpoints](https://docs.github.com/enterprise-server@2.18/rest/reference/repos#invitations).\n\n**Rate limits**\n\nTo prevent abuse, you are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.", + "description": "This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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.18/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\nFor more information the permission levels, see \"[Repository permission levels for an organization](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#http-verbs).\"\n\nThe invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [repository invitations API endpoints](https://docs.github.com/enterprise-server@2.18/rest/reference/repos#invitations).\n\n**Rate limits**\n\nTo prevent abuse, you are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.", "tags": [ "repos" ], @@ -28981,7 +28981,7 @@ "subcategory": "collaborators", "subcategoryLabel": "Collaborators", "notes": [], - "descriptionHTML": "

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

\n

For more information the permission levels, see \"Repository permission levels for an organization\".

\n

Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"

\n

The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the repository invitations API endpoints.

\n

Rate limits

\n

To prevent abuse, you are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.

", + "descriptionHTML": "

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

\n

For more information the permission levels, see \"Repository permission levels for an organization\".

\n

Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"

\n

The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the repository invitations API endpoints.

\n

Rate limits

\n

To prevent abuse, you are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.

", "bodyParameters": [ { "type": "string", @@ -30293,7 +30293,7 @@ } ], "summary": "Create a commit comment", - "description": "Create a comment for a commit using its `:commit_sha`.\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.18/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", + "description": "Create a comment for a commit using its `:commit_sha`.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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.18/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", "tags": [ "repos" ], @@ -30372,7 +30372,7 @@ "subcategory": "comments", "subcategoryLabel": "Comments", "notes": [], - "descriptionHTML": "

Create a comment for a commit using its :commit_sha.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", + "descriptionHTML": "

Create a comment for a commit using its :commit_sha.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", "bodyParameters": [ { "type": "string", @@ -38061,7 +38061,7 @@ } ], "summary": "Create an issue", - "description": "Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://help.github.com/articles/disabling-issues/), the API returns a `410 Gone` status.\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.18/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)\" for details.", + "description": "Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://help.github.com/articles/disabling-issues/), the API returns a `410 Gone` status.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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.18/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)\" for details.", "tags": [ "issues" ], @@ -38190,7 +38190,7 @@ "category": "issues", "categoryLabel": "Issues", "notes": [], - "descriptionHTML": "

Any user with pull access to a repository can create an issue. If issues are disabled in the repository, the API returns a 410 Gone status.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", + "descriptionHTML": "

Any user with pull access to a repository can create an issue. If issues are disabled in the repository, the API returns a 410 Gone status.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", "bodyParameters": [ { "type": "string", @@ -40106,7 +40106,7 @@ } ], "summary": "Create an issue comment", - "description": "This 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.18/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)\" for details.", + "description": "This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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.18/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)\" for details.", "tags": [ "issues" ], @@ -40155,7 +40155,7 @@ "subcategory": "comments", "subcategoryLabel": "Comments", "notes": [], - "descriptionHTML": "

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", + "descriptionHTML": "

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", "bodyParameters": [ { "type": "string", @@ -46927,7 +46927,7 @@ } ], "summary": "Create a review comment for a pull request (alternative)", - "description": "Creates 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.18/rest/reference/issues#create-an-issue-comment).\"\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.18/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" for details.", + "description": "Creates 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.18/rest/reference/issues#create-an-issue-comment).\"\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://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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.18/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" for details.", "operationId": "pulls/create-review-comment-alternative", "tags": [ "pulls" @@ -46985,7 +46985,7 @@ "subcategory": "comments", "subcategoryLabel": "Comments", "notes": [], - "descriptionHTML": "

Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"Create an issue comment.\"

\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

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" for details.

", + "descriptionHTML": "

Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"Create an issue comment.\"

\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

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" for details.

", "bodyParameters": [ { "type": "string", @@ -47071,7 +47071,7 @@ } ], "summary": "Create a reply for a review comment", - "description": "Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported.\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.18/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", + "description": "Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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.18/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", "tags": [ "pulls" ], @@ -47120,7 +47120,7 @@ "subcategory": "comments", "subcategoryLabel": "Comments", "notes": [], - "descriptionHTML": "

Creates a reply to a review comment for a pull request. For the comment_id, provide the ID of the review comment you are replying to. This must be the ID of a top-level review comment, not a reply to that comment. Replies to replies are not supported.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", + "descriptionHTML": "

Creates a reply to a review comment for a pull request. For the comment_id, provide the ID of the review comment you are replying to. This must be the ID of a top-level review comment, not a reply to that comment. Replies to replies are not supported.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", "bodyParameters": [ { "type": "string", @@ -48187,7 +48187,7 @@ } ], "summary": "Create a review for a pull request", - "description": "This 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.18/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\nPull request reviews created in the `PENDING` state do not include the `submitted_at` property in the response.\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API v3 offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/enterprise-server@2.18/rest/reference/pulls#get-a-pull-request) endpoint.\n\nThe `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.", + "description": "This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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.18/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\nPull request reviews created in the `PENDING` state do not include the `submitted_at` property in the response.\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API v3 offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/enterprise-server@2.18/rest/reference/pulls#get-a-pull-request) endpoint.\n\nThe `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.", "tags": [ "pulls" ], @@ -48417,7 +48417,7 @@ "subcategory": "reviews", "subcategoryLabel": "Reviews", "notes": [], - "descriptionHTML": "

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

\n

Pull request reviews created in the PENDING state do not include the submitted_at property in the response.

\n

Note: To comment on a specific line in a file, you need to first determine the position of that line in the diff. The GitHub REST API v3 offers the application/vnd.github.v3.diff media type. To see a pull request diff, add this media type to the Accept header of a call to the single pull request endpoint.

\n

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.

", + "descriptionHTML": "

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

\n

Pull request reviews created in the PENDING state do not include the submitted_at property in the response.

\n

Note: To comment on a specific line in a file, you need to first determine the position of that line in the diff. The GitHub REST API v3 offers the application/vnd.github.v3.diff media type. To see a pull request diff, add this media type to the Accept header of a call to the single pull request endpoint.

\n

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.

", "responses": [ { "httpStatusCode": "200", @@ -49729,7 +49729,7 @@ } ], "summary": "Create a release", - "description": "Users with push access to the repository can create a release.\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.18/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", + "description": "Users with push access to the repository can create a release.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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.18/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", "tags": [ "repos" ], @@ -49830,7 +49830,7 @@ "subcategory": "releases", "subcategoryLabel": "Releases", "notes": [], - "descriptionHTML": "

Users with push access to the repository can create a release.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", + "descriptionHTML": "

Users with push access to the repository can create a release.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", "bodyParameters": [ { "type": "string", @@ -55192,7 +55192,7 @@ } ], "summary": "Create a discussion", - "description": "Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\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.18/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" for details.", + "description": "Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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.18/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" for details.", "operationId": "teams/create-discussion", "tags": [ "teams" @@ -55275,7 +55275,7 @@ "subcategory": "discussions", "subcategoryLabel": "Discussions", "notes": [], - "descriptionHTML": "

Creates a new discussion post on a team's page. OAuth access tokens require the write:discussion scope.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" for details.

", + "descriptionHTML": "

Creates a new discussion post on a team's page. OAuth access tokens require the write:discussion scope.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" for details.

", "bodyParameters": [ { "type": "string", @@ -55818,7 +55818,7 @@ } ], "summary": "Create a discussion comment", - "description": "Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\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.18/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" for details.", + "description": "Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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.18/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" for details.", "operationId": "teams/create-discussion-comment", "tags": [ "teams" @@ -55880,7 +55880,7 @@ "subcategory": "discussion-comments", "subcategoryLabel": "Discussion comments", "notes": [], - "descriptionHTML": "

Creates a new comment on a team discussion. OAuth access tokens require the write:discussion scope.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" for details.

", + "descriptionHTML": "

Creates a new comment on a team discussion. OAuth access tokens require the write:discussion scope.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" for details.

", "bodyParameters": [ { "type": "string", diff --git a/lib/rest/static/decorated/ghes-2.19.json b/lib/rest/static/decorated/ghes-2.19.json index d62b99482a..d6f3ad5e44 100644 --- a/lib/rest/static/decorated/ghes-2.19.json +++ b/lib/rest/static/decorated/ghes-2.19.json @@ -9429,7 +9429,7 @@ "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Default response", - "payload": "
[\n  {\n    \"url\": \"https://api.github.com/gists/dee9c42e4998ce2ea439\",\n    \"id\": \"dee9c42e4998ce2ea439\",\n    \"created_at\": \"2011-04-14T16:00:49Z\",\n    \"updated_at\": \"2011-04-14T16:00:49Z\"\n  }\n]\n
" + "payload": "
[\n  {\n    \"url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d\",\n    \"forks_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\n    \"commits_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\n    \"id\": \"aa5a315d61ae9438b18d\",\n    \"node_id\": \"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\n    \"git_pull_url\": \"https://gist.github.com/aa5a315d61ae9438b18d.git\",\n    \"git_push_url\": \"https://gist.github.com/aa5a315d61ae9438b18d.git\",\n    \"html_url\": \"https://gist.github.com/aa5a315d61ae9438b18d\",\n    \"files\": {\n      \"hello_world.rb\": {\n        \"filename\": \"hello_world.rb\",\n        \"type\": \"application/x-ruby\",\n        \"language\": \"Ruby\",\n        \"raw_url\": \"https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb\",\n        \"size\": 167\n      }\n    },\n    \"public\": true,\n    \"created_at\": \"2010-04-14T02:15:15Z\",\n    \"updated_at\": \"2011-06-20T11:34:15Z\",\n    \"description\": \"Hello World Examples\",\n    \"comments\": 1,\n    \"user\": null,\n    \"comments_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\",\n    \"owner\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    }\n  }\n]\n
" }, { "httpStatusCode": "304", @@ -29484,7 +29484,7 @@ } ], "summary": "Add a repository collaborator", - "description": "This 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.19/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.19/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\nFor more information the permission levels, see \"[Repository permission levels for an organization](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@2.19/rest/overview/resources-in-the-rest-api#http-verbs).\"\n\nThe invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [repository invitations API endpoints](https://docs.github.com/enterprise-server@2.19/rest/reference/repos#invitations).\n\n**Rate limits**\n\nTo prevent abuse, you are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.", + "description": "This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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.19/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.19/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\nFor more information the permission levels, see \"[Repository permission levels for an organization](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@2.19/rest/overview/resources-in-the-rest-api#http-verbs).\"\n\nThe invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [repository invitations API endpoints](https://docs.github.com/enterprise-server@2.19/rest/reference/repos#invitations).\n\n**Rate limits**\n\nTo prevent abuse, you are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.", "tags": [ "repos" ], @@ -29544,7 +29544,7 @@ "subcategory": "collaborators", "subcategoryLabel": "Collaborators", "notes": [], - "descriptionHTML": "

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

\n

For more information the permission levels, see \"Repository permission levels for an organization\".

\n

Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"

\n

The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the repository invitations API endpoints.

\n

Rate limits

\n

To prevent abuse, you are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.

", + "descriptionHTML": "

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

\n

For more information the permission levels, see \"Repository permission levels for an organization\".

\n

Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"

\n

The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the repository invitations API endpoints.

\n

Rate limits

\n

To prevent abuse, you are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.

", "bodyParameters": [ { "type": "string", @@ -30856,7 +30856,7 @@ } ], "summary": "Create a commit comment", - "description": "Create a comment for a commit using its `:commit_sha`.\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.19/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.19/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", + "description": "Create a comment for a commit using its `:commit_sha`.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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.19/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.19/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", "tags": [ "repos" ], @@ -30935,7 +30935,7 @@ "subcategory": "comments", "subcategoryLabel": "Comments", "notes": [], - "descriptionHTML": "

Create a comment for a commit using its :commit_sha.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", + "descriptionHTML": "

Create a comment for a commit using its :commit_sha.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", "bodyParameters": [ { "type": "string", @@ -38720,7 +38720,7 @@ } ], "summary": "Create an issue", - "description": "Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://help.github.com/articles/disabling-issues/), the API returns a `410 Gone` status.\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.19/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.19/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)\" for details.", + "description": "Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://help.github.com/articles/disabling-issues/), the API returns a `410 Gone` status.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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.19/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.19/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)\" for details.", "tags": [ "issues" ], @@ -38849,7 +38849,7 @@ "category": "issues", "categoryLabel": "Issues", "notes": [], - "descriptionHTML": "

Any user with pull access to a repository can create an issue. If issues are disabled in the repository, the API returns a 410 Gone status.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", + "descriptionHTML": "

Any user with pull access to a repository can create an issue. If issues are disabled in the repository, the API returns a 410 Gone status.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", "bodyParameters": [ { "type": "string", @@ -40765,7 +40765,7 @@ } ], "summary": "Create an issue comment", - "description": "This 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.19/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.19/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)\" for details.", + "description": "This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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.19/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.19/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)\" for details.", "tags": [ "issues" ], @@ -40814,7 +40814,7 @@ "subcategory": "comments", "subcategoryLabel": "Comments", "notes": [], - "descriptionHTML": "

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", + "descriptionHTML": "

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", "bodyParameters": [ { "type": "string", @@ -47723,7 +47723,7 @@ } ], "summary": "Create a review comment for a pull request (alternative)", - "description": "Creates 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.19/rest/reference/issues#create-an-issue-comment).\"\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.19/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" for details.", + "description": "Creates 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.19/rest/reference/issues#create-an-issue-comment).\"\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://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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.19/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" for details.", "operationId": "pulls/create-review-comment-alternative", "tags": [ "pulls" @@ -47781,7 +47781,7 @@ "subcategory": "comments", "subcategoryLabel": "Comments", "notes": [], - "descriptionHTML": "

Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"Create an issue comment.\"

\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

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" for details.

", + "descriptionHTML": "

Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"Create an issue comment.\"

\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

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" for details.

", "bodyParameters": [ { "type": "string", @@ -47867,7 +47867,7 @@ } ], "summary": "Create a reply for a review comment", - "description": "Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported.\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.19/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.19/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", + "description": "Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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.19/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.19/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", "tags": [ "pulls" ], @@ -47916,7 +47916,7 @@ "subcategory": "comments", "subcategoryLabel": "Comments", "notes": [], - "descriptionHTML": "

Creates a reply to a review comment for a pull request. For the comment_id, provide the ID of the review comment you are replying to. This must be the ID of a top-level review comment, not a reply to that comment. Replies to replies are not supported.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", + "descriptionHTML": "

Creates a reply to a review comment for a pull request. For the comment_id, provide the ID of the review comment you are replying to. This must be the ID of a top-level review comment, not a reply to that comment. Replies to replies are not supported.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", "bodyParameters": [ { "type": "string", @@ -48983,7 +48983,7 @@ } ], "summary": "Create a review for a pull request", - "description": "This 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.19/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.19/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\nPull request reviews created in the `PENDING` state do not include the `submitted_at` property in the response.\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API v3 offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/enterprise-server@2.19/rest/reference/pulls#get-a-pull-request) endpoint.\n\nThe `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.", + "description": "This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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.19/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.19/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\nPull request reviews created in the `PENDING` state do not include the `submitted_at` property in the response.\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API v3 offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/enterprise-server@2.19/rest/reference/pulls#get-a-pull-request) endpoint.\n\nThe `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.", "tags": [ "pulls" ], @@ -49213,7 +49213,7 @@ "subcategory": "reviews", "subcategoryLabel": "Reviews", "notes": [], - "descriptionHTML": "

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

\n

Pull request reviews created in the PENDING state do not include the submitted_at property in the response.

\n

Note: To comment on a specific line in a file, you need to first determine the position of that line in the diff. The GitHub REST API v3 offers the application/vnd.github.v3.diff media type. To see a pull request diff, add this media type to the Accept header of a call to the single pull request endpoint.

\n

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.

", + "descriptionHTML": "

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

\n

Pull request reviews created in the PENDING state do not include the submitted_at property in the response.

\n

Note: To comment on a specific line in a file, you need to first determine the position of that line in the diff. The GitHub REST API v3 offers the application/vnd.github.v3.diff media type. To see a pull request diff, add this media type to the Accept header of a call to the single pull request endpoint.

\n

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.

", "responses": [ { "httpStatusCode": "200", @@ -50525,7 +50525,7 @@ } ], "summary": "Create a release", - "description": "Users with push access to the repository can create a release.\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.19/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.19/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", + "description": "Users with push access to the repository can create a release.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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.19/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.19/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", "tags": [ "repos" ], @@ -50626,7 +50626,7 @@ "subcategory": "releases", "subcategoryLabel": "Releases", "notes": [], - "descriptionHTML": "

Users with push access to the repository can create a release.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", + "descriptionHTML": "

Users with push access to the repository can create a release.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", "bodyParameters": [ { "type": "string", @@ -55959,7 +55959,7 @@ } ], "summary": "Create a discussion", - "description": "Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.19/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\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.19/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" for details.", + "description": "Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.19/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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.19/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" for details.", "operationId": "teams/create-discussion", "tags": [ "teams" @@ -56035,7 +56035,7 @@ "subcategory": "discussions", "subcategoryLabel": "Discussions", "notes": [], - "descriptionHTML": "

Creates a new discussion post on a team's page. OAuth access tokens require the write:discussion scope.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" for details.

", + "descriptionHTML": "

Creates a new discussion post on a team's page. OAuth access tokens require the write:discussion scope.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" for details.

", "bodyParameters": [ { "type": "string", @@ -56495,7 +56495,7 @@ } ], "summary": "Create a discussion comment", - "description": "Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.19/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\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.19/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" for details.", + "description": "Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.19/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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.19/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" for details.", "operationId": "teams/create-discussion-comment", "tags": [ "teams" @@ -56550,7 +56550,7 @@ "subcategory": "discussion-comments", "subcategoryLabel": "Discussion comments", "notes": [], - "descriptionHTML": "

Creates a new comment on a team discussion. OAuth access tokens require the write:discussion scope.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" for details.

", + "descriptionHTML": "

Creates a new comment on a team discussion. OAuth access tokens require the write:discussion scope.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" for details.

", "bodyParameters": [ { "type": "string", diff --git a/lib/rest/static/decorated/ghes-2.20.json b/lib/rest/static/decorated/ghes-2.20.json index d2205c065d..1da03f9494 100644 --- a/lib/rest/static/decorated/ghes-2.20.json +++ b/lib/rest/static/decorated/ghes-2.20.json @@ -9850,7 +9850,7 @@ "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Default response", - "payload": "
[\n  {\n    \"url\": \"https://api.github.com/gists/dee9c42e4998ce2ea439\",\n    \"id\": \"dee9c42e4998ce2ea439\",\n    \"created_at\": \"2011-04-14T16:00:49Z\",\n    \"updated_at\": \"2011-04-14T16:00:49Z\"\n  }\n]\n
" + "payload": "
[\n  {\n    \"url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d\",\n    \"forks_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\n    \"commits_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\n    \"id\": \"aa5a315d61ae9438b18d\",\n    \"node_id\": \"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\n    \"git_pull_url\": \"https://gist.github.com/aa5a315d61ae9438b18d.git\",\n    \"git_push_url\": \"https://gist.github.com/aa5a315d61ae9438b18d.git\",\n    \"html_url\": \"https://gist.github.com/aa5a315d61ae9438b18d\",\n    \"files\": {\n      \"hello_world.rb\": {\n        \"filename\": \"hello_world.rb\",\n        \"type\": \"application/x-ruby\",\n        \"language\": \"Ruby\",\n        \"raw_url\": \"https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb\",\n        \"size\": 167\n      }\n    },\n    \"public\": true,\n    \"created_at\": \"2010-04-14T02:15:15Z\",\n    \"updated_at\": \"2011-06-20T11:34:15Z\",\n    \"description\": \"Hello World Examples\",\n    \"comments\": 1,\n    \"user\": null,\n    \"comments_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\",\n    \"owner\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    }\n  }\n]\n
" }, { "httpStatusCode": "304", @@ -29955,7 +29955,7 @@ } ], "summary": "Add a repository collaborator", - "description": "This 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\nFor more information the permission levels, see \"[Repository permission levels for an organization](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@2.20/rest/overview/resources-in-the-rest-api#http-verbs).\"\n\nThe invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [repository invitations API endpoints](https://docs.github.com/enterprise-server@2.20/rest/reference/repos#invitations).\n\n**Rate limits**\n\nTo prevent abuse, you are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.", + "description": "This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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\nFor more information the permission levels, see \"[Repository permission levels for an organization](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@2.20/rest/overview/resources-in-the-rest-api#http-verbs).\"\n\nThe invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [repository invitations API endpoints](https://docs.github.com/enterprise-server@2.20/rest/reference/repos#invitations).\n\n**Rate limits**\n\nTo prevent abuse, you are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.", "tags": [ "repos" ], @@ -30015,7 +30015,7 @@ "subcategory": "collaborators", "subcategoryLabel": "Collaborators", "notes": [], - "descriptionHTML": "

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

\n

For more information the permission levels, see \"Repository permission levels for an organization\".

\n

Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"

\n

The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the repository invitations API endpoints.

\n

Rate limits

\n

To prevent abuse, you are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.

", + "descriptionHTML": "

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

\n

For more information the permission levels, see \"Repository permission levels for an organization\".

\n

Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"

\n

The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the repository invitations API endpoints.

\n

Rate limits

\n

To prevent abuse, you are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.

", "bodyParameters": [ { "type": "string", @@ -31327,7 +31327,7 @@ } ], "summary": "Create a commit comment", - "description": "Create a comment for a commit using its `:commit_sha`.\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.", + "description": "Create a comment for a commit using its `:commit_sha`.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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": [ "repos" ], @@ -31406,7 +31406,7 @@ "subcategory": "comments", "subcategoryLabel": "Comments", "notes": [], - "descriptionHTML": "

Create a comment for a commit using its :commit_sha.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", + "descriptionHTML": "

Create a comment for a commit using its :commit_sha.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", "bodyParameters": [ { "type": "string", @@ -39191,7 +39191,7 @@ } ], "summary": "Create an issue", - "description": "Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://help.github.com/articles/disabling-issues/), the API returns a `410 Gone` status.\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-abuse-rate-limits)\" for details.", + "description": "Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://help.github.com/articles/disabling-issues/), the API returns a `410 Gone` status.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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-abuse-rate-limits)\" for details.", "tags": [ "issues" ], @@ -39320,7 +39320,7 @@ "category": "issues", "categoryLabel": "Issues", "notes": [], - "descriptionHTML": "

Any user with pull access to a repository can create an issue. If issues are disabled in the repository, the API returns a 410 Gone status.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", + "descriptionHTML": "

Any user with pull access to a repository can create an issue. If issues are disabled in the repository, the API returns a 410 Gone status.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", "bodyParameters": [ { "type": "string", @@ -41236,7 +41236,7 @@ } ], "summary": "Create an issue comment", - "description": "This 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-abuse-rate-limits)\" for details.", + "description": "This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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-abuse-rate-limits)\" for details.", "tags": [ "issues" ], @@ -41285,7 +41285,7 @@ "subcategory": "comments", "subcategoryLabel": "Comments", "notes": [], - "descriptionHTML": "

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", + "descriptionHTML": "

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", "bodyParameters": [ { "type": "string", @@ -48194,7 +48194,7 @@ } ], "summary": "Create a review comment for a pull request", - "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.", + "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://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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" ], @@ -48353,7 +48353,7 @@ "subcategory": "comments", "subcategoryLabel": "Comments", "notes": [], - "descriptionHTML": "

Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"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

You 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.

\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

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", + "descriptionHTML": "

Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"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

You 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.

\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

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", "bodyParameters": [ { "type": "string", @@ -48521,7 +48521,7 @@ } ], "summary": "Create a reply for a review comment", - "description": "Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported.\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.", + "description": "Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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" ], @@ -48570,7 +48570,7 @@ "subcategory": "comments", "subcategoryLabel": "Comments", "notes": [], - "descriptionHTML": "

Creates a reply to a review comment for a pull request. For the comment_id, provide the ID of the review comment you are replying to. This must be the ID of a top-level review comment, not a reply to that comment. Replies to replies are not supported.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", + "descriptionHTML": "

Creates a reply to a review comment for a pull request. For the comment_id, provide the ID of the review comment you are replying to. This must be the ID of a top-level review comment, not a reply to that comment. Replies to replies are not supported.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", "bodyParameters": [ { "type": "string", @@ -49637,7 +49637,7 @@ } ], "summary": "Create a review for a pull request", - "description": "This 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\nPull request reviews created in the `PENDING` state do not include the `submitted_at` property in the response.\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API v3 offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/enterprise-server@2.20/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/enterprise-server@2.20/rest/reference/pulls#get-a-pull-request) endpoint.\n\nThe `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.", + "description": "This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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\nPull request reviews created in the `PENDING` state do not include the `submitted_at` property in the response.\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API v3 offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/enterprise-server@2.20/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/enterprise-server@2.20/rest/reference/pulls#get-a-pull-request) endpoint.\n\nThe `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.", "tags": [ "pulls" ], @@ -49867,7 +49867,7 @@ "subcategory": "reviews", "subcategoryLabel": "Reviews", "notes": [], - "descriptionHTML": "

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

\n

Pull request reviews created in the PENDING state do not include the submitted_at property in the response.

\n

Note: To comment on a specific line in a file, you need to first determine the position of that line in the diff. The GitHub REST API v3 offers the application/vnd.github.v3.diff media type. To see a pull request diff, add this media type to the Accept header of a call to the single pull request endpoint.

\n

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.

", + "descriptionHTML": "

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

\n

Pull request reviews created in the PENDING state do not include the submitted_at property in the response.

\n

Note: To comment on a specific line in a file, you need to first determine the position of that line in the diff. The GitHub REST API v3 offers the application/vnd.github.v3.diff media type. To see a pull request diff, add this media type to the Accept header of a call to the single pull request endpoint.

\n

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.

", "responses": [ { "httpStatusCode": "200", @@ -51179,7 +51179,7 @@ } ], "summary": "Create a release", - "description": "Users with push access to the repository can create a release.\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.", + "description": "Users with push access to the repository can create a release.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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": [ "repos" ], @@ -51280,7 +51280,7 @@ "subcategory": "releases", "subcategoryLabel": "Releases", "notes": [], - "descriptionHTML": "

Users with push access to the repository can create a release.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", + "descriptionHTML": "

Users with push access to the repository can create a release.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", "bodyParameters": [ { "type": "string", @@ -56589,7 +56589,7 @@ } ], "summary": "Create a discussion", - "description": "Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.20/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\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)\" for details.", + "description": "Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.20/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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)\" for details.", "operationId": "teams/create-discussion", "tags": [ "teams" @@ -56665,7 +56665,7 @@ "subcategory": "discussions", "subcategoryLabel": "Discussions", "notes": [], - "descriptionHTML": "

Creates a new discussion post on a team's page. OAuth access tokens require the write:discussion scope.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" for details.

", + "descriptionHTML": "

Creates a new discussion post on a team's page. OAuth access tokens require the write:discussion scope.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" for details.

", "bodyParameters": [ { "type": "string", @@ -57125,7 +57125,7 @@ } ], "summary": "Create a discussion comment", - "description": "Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.20/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\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)\" for details.", + "description": "Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.20/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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)\" for details.", "operationId": "teams/create-discussion-comment", "tags": [ "teams" @@ -57180,7 +57180,7 @@ "subcategory": "discussion-comments", "subcategoryLabel": "Discussion comments", "notes": [], - "descriptionHTML": "

Creates a new comment on a team discussion. OAuth access tokens require the write:discussion scope.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" for details.

", + "descriptionHTML": "

Creates a new comment on a team discussion. OAuth access tokens require the write:discussion scope.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" for details.

", "bodyParameters": [ { "type": "string", diff --git a/lib/rest/static/decorated/ghes-2.21.json b/lib/rest/static/decorated/ghes-2.21.json index 989484b388..ec15d98d28 100644 --- a/lib/rest/static/decorated/ghes-2.21.json +++ b/lib/rest/static/decorated/ghes-2.21.json @@ -9844,7 +9844,7 @@ "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Default response", - "payload": "
[\n  {\n    \"url\": \"https://api.github.com/gists/dee9c42e4998ce2ea439\",\n    \"id\": \"dee9c42e4998ce2ea439\",\n    \"created_at\": \"2011-04-14T16:00:49Z\",\n    \"updated_at\": \"2011-04-14T16:00:49Z\"\n  }\n]\n
" + "payload": "
[\n  {\n    \"url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d\",\n    \"forks_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\n    \"commits_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\n    \"id\": \"aa5a315d61ae9438b18d\",\n    \"node_id\": \"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\n    \"git_pull_url\": \"https://gist.github.com/aa5a315d61ae9438b18d.git\",\n    \"git_push_url\": \"https://gist.github.com/aa5a315d61ae9438b18d.git\",\n    \"html_url\": \"https://gist.github.com/aa5a315d61ae9438b18d\",\n    \"files\": {\n      \"hello_world.rb\": {\n        \"filename\": \"hello_world.rb\",\n        \"type\": \"application/x-ruby\",\n        \"language\": \"Ruby\",\n        \"raw_url\": \"https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb\",\n        \"size\": 167\n      }\n    },\n    \"public\": true,\n    \"created_at\": \"2010-04-14T02:15:15Z\",\n    \"updated_at\": \"2011-06-20T11:34:15Z\",\n    \"description\": \"Hello World Examples\",\n    \"comments\": 1,\n    \"user\": null,\n    \"comments_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\",\n    \"owner\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    }\n  }\n]\n
" }, { "httpStatusCode": "304", @@ -17282,7 +17282,7 @@ } ], "summary": "Create a discussion", - "description": "Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.21/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\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**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`.", + "description": "Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.21/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`.", "tags": [ "teams" ], @@ -17359,7 +17359,7 @@ "subcategory": "discussions", "subcategoryLabel": "Discussions", "notes": [], - "descriptionHTML": "

Creates a new discussion post on a team's page. OAuth access tokens require the write:discussion scope.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

\n

Note: You can also specify a team by org_id and team_id using the route POST /organizations/{org_id}/team/{team_id}/discussions.

", + "descriptionHTML": "

Creates a new discussion post on a team's page. OAuth access tokens require the write:discussion scope.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

\n

Note: You can also specify a team by org_id and team_id using the route POST /organizations/{org_id}/team/{team_id}/discussions.

", "bodyParameters": [ { "type": "string", @@ -17872,7 +17872,7 @@ } ], "summary": "Create a discussion comment", - "description": "Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.21/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\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**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.", + "description": "Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.21/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.", "tags": [ "teams" ], @@ -17928,7 +17928,7 @@ "subcategory": "discussion-comments", "subcategoryLabel": "Discussion comments", "notes": [], - "descriptionHTML": "

Creates a new comment on a team discussion. OAuth access tokens require the write:discussion scope.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

\n

Note: You can also specify a team by org_id and team_id using the route POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments.

", + "descriptionHTML": "

Creates a new comment on a team discussion. OAuth access tokens require the write:discussion scope.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

\n

Note: You can also specify a team by org_id and team_id using the route POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments.

", "bodyParameters": [ { "type": "string", @@ -33422,7 +33422,7 @@ } ], "summary": "Add a repository collaborator", - "description": "This 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\nFor more information the permission levels, see \"[Repository permission levels for an organization](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@2.21/rest/overview/resources-in-the-rest-api#http-verbs).\"\n\nThe invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [repository invitations API endpoints](https://docs.github.com/enterprise-server@2.21/rest/reference/repos#invitations).\n\n**Rate limits**\n\nTo prevent abuse, you are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.", + "description": "This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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\nFor more information the permission levels, see \"[Repository permission levels for an organization](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@2.21/rest/overview/resources-in-the-rest-api#http-verbs).\"\n\nThe invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [repository invitations API endpoints](https://docs.github.com/enterprise-server@2.21/rest/reference/repos#invitations).\n\n**Rate limits**\n\nTo prevent abuse, you are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.", "tags": [ "repos" ], @@ -33482,7 +33482,7 @@ "subcategory": "collaborators", "subcategoryLabel": "Collaborators", "notes": [], - "descriptionHTML": "

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

\n

For more information the permission levels, see \"Repository permission levels for an organization\".

\n

Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"

\n

The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the repository invitations API endpoints.

\n

Rate limits

\n

To prevent abuse, you are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.

", + "descriptionHTML": "

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

\n

For more information the permission levels, see \"Repository permission levels for an organization\".

\n

Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"

\n

The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the repository invitations API endpoints.

\n

Rate limits

\n

To prevent abuse, you are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.

", "bodyParameters": [ { "type": "string", @@ -34887,7 +34887,7 @@ } ], "summary": "Create a commit comment", - "description": "Create a comment for a commit using its `:commit_sha`.\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.", + "description": "Create a comment for a commit using its `:commit_sha`.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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": [ "repos" ], @@ -34966,7 +34966,7 @@ "subcategory": "comments", "subcategoryLabel": "Comments", "notes": [], - "descriptionHTML": "

Create a comment for a commit using its :commit_sha.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", + "descriptionHTML": "

Create a comment for a commit using its :commit_sha.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", "bodyParameters": [ { "type": "string", @@ -42840,7 +42840,7 @@ } ], "summary": "Create an issue", - "description": "Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://help.github.com/articles/disabling-issues/), the API returns a `410 Gone` status.\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-abuse-rate-limits)\" for details.", + "description": "Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://help.github.com/articles/disabling-issues/), the API returns a `410 Gone` status.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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-abuse-rate-limits)\" for details.", "tags": [ "issues" ], @@ -42969,7 +42969,7 @@ "category": "issues", "categoryLabel": "Issues", "notes": [], - "descriptionHTML": "

Any user with pull access to a repository can create an issue. If issues are disabled in the repository, the API returns a 410 Gone status.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", + "descriptionHTML": "

Any user with pull access to a repository can create an issue. If issues are disabled in the repository, the API returns a 410 Gone status.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", "bodyParameters": [ { "type": "string", @@ -44978,7 +44978,7 @@ } ], "summary": "Create an issue comment", - "description": "This 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-abuse-rate-limits)\" for details.", + "description": "This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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-abuse-rate-limits)\" for details.", "tags": [ "issues" ], @@ -45027,7 +45027,7 @@ "subcategory": "comments", "subcategoryLabel": "Comments", "notes": [], - "descriptionHTML": "

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", + "descriptionHTML": "

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", "bodyParameters": [ { "type": "string", @@ -52104,7 +52104,7 @@ } ], "summary": "Create a review comment for a pull request", - "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.", + "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://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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" ], @@ -52263,7 +52263,7 @@ "subcategory": "comments", "subcategoryLabel": "Comments", "notes": [], - "descriptionHTML": "

Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"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

You 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.

\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

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", + "descriptionHTML": "

Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"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

You 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.

\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

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", "bodyParameters": [ { "type": "string", @@ -52431,7 +52431,7 @@ } ], "summary": "Create a reply for a review comment", - "description": "Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported.\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.", + "description": "Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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" ], @@ -52480,7 +52480,7 @@ "subcategory": "comments", "subcategoryLabel": "Comments", "notes": [], - "descriptionHTML": "

Creates a reply to a review comment for a pull request. For the comment_id, provide the ID of the review comment you are replying to. This must be the ID of a top-level review comment, not a reply to that comment. Replies to replies are not supported.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", + "descriptionHTML": "

Creates a reply to a review comment for a pull request. For the comment_id, provide the ID of the review comment you are replying to. This must be the ID of a top-level review comment, not a reply to that comment. Replies to replies are not supported.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", "bodyParameters": [ { "type": "string", @@ -53547,7 +53547,7 @@ } ], "summary": "Create a review for a pull request", - "description": "This 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\nPull request reviews created in the `PENDING` state do not include the `submitted_at` property in the response.\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API v3 offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/enterprise-server@2.21/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/enterprise-server@2.21/rest/reference/pulls#get-a-pull-request) endpoint.\n\nThe `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.", + "description": "This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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\nPull request reviews created in the `PENDING` state do not include the `submitted_at` property in the response.\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API v3 offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/enterprise-server@2.21/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/enterprise-server@2.21/rest/reference/pulls#get-a-pull-request) endpoint.\n\nThe `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.", "tags": [ "pulls" ], @@ -53777,7 +53777,7 @@ "subcategory": "reviews", "subcategoryLabel": "Reviews", "notes": [], - "descriptionHTML": "

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

\n

Pull request reviews created in the PENDING state do not include the submitted_at property in the response.

\n

Note: To comment on a specific line in a file, you need to first determine the position of that line in the diff. The GitHub REST API v3 offers the application/vnd.github.v3.diff media type. To see a pull request diff, add this media type to the Accept header of a call to the single pull request endpoint.

\n

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.

", + "descriptionHTML": "

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

\n

Pull request reviews created in the PENDING state do not include the submitted_at property in the response.

\n

Note: To comment on a specific line in a file, you need to first determine the position of that line in the diff. The GitHub REST API v3 offers the application/vnd.github.v3.diff media type. To see a pull request diff, add this media type to the Accept header of a call to the single pull request endpoint.

\n

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.

", "responses": [ { "httpStatusCode": "200", @@ -55089,7 +55089,7 @@ } ], "summary": "Create a release", - "description": "Users with push access to the repository can create a release.\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.", + "description": "Users with push access to the repository can create a release.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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": [ "repos" ], @@ -55190,7 +55190,7 @@ "subcategory": "releases", "subcategoryLabel": "Releases", "notes": [], - "descriptionHTML": "

Users with push access to the repository can create a release.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", + "descriptionHTML": "

Users with push access to the repository can create a release.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", "bodyParameters": [ { "type": "string", @@ -60547,7 +60547,7 @@ } ], "summary": "Create a discussion (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/enterprise-server@2.21/rest/reference/teams#create-a-discussion) endpoint.\n\nCreates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.21/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\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.", + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/enterprise-server@2.21/rest/reference/teams#create-a-discussion) endpoint.\n\nCreates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.21/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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": [ "teams" ], @@ -60627,7 +60627,7 @@ "subcategory": "discussions", "subcategoryLabel": "Discussions", "notes": [], - "descriptionHTML": "

Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create a discussion endpoint.

\n

Creates a new discussion post on a team's page. OAuth access tokens require the write:discussion scope.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", + "descriptionHTML": "

Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create a discussion endpoint.

\n

Creates a new discussion post on a team's page. OAuth access tokens require the write:discussion scope.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", "bodyParameters": [ { "type": "string", @@ -61102,7 +61102,7 @@ } ], "summary": "Create a discussion comment (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/enterprise-server@2.21/rest/reference/teams#create-a-discussion-comment) endpoint.\n\nCreates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.21/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\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.", + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/enterprise-server@2.21/rest/reference/teams#create-a-discussion-comment) endpoint.\n\nCreates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.21/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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": [ "teams" ], @@ -61161,7 +61161,7 @@ "subcategory": "discussion-comments", "subcategoryLabel": "Discussion comments", "notes": [], - "descriptionHTML": "

Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create a discussion comment endpoint.

\n

Creates a new comment on a team discussion. OAuth access tokens require the write:discussion scope.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", + "descriptionHTML": "

Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create a discussion comment endpoint.

\n

Creates a new comment on a team discussion. OAuth access tokens require the write:discussion scope.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", "bodyParameters": [ { "type": "string", diff --git a/lib/rest/static/decorated/ghes-2.22.json b/lib/rest/static/decorated/ghes-2.22.json index 3dda52d72c..a88731d188 100644 --- a/lib/rest/static/decorated/ghes-2.22.json +++ b/lib/rest/static/decorated/ghes-2.22.json @@ -11489,7 +11489,7 @@ "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Default response", - "payload": "
[\n  {\n    \"url\": \"https://api.github.com/gists/dee9c42e4998ce2ea439\",\n    \"id\": \"dee9c42e4998ce2ea439\",\n    \"created_at\": \"2011-04-14T16:00:49Z\",\n    \"updated_at\": \"2011-04-14T16:00:49Z\"\n  }\n]\n
" + "payload": "
[\n  {\n    \"url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d\",\n    \"forks_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\n    \"commits_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\n    \"id\": \"aa5a315d61ae9438b18d\",\n    \"node_id\": \"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\n    \"git_pull_url\": \"https://gist.github.com/aa5a315d61ae9438b18d.git\",\n    \"git_push_url\": \"https://gist.github.com/aa5a315d61ae9438b18d.git\",\n    \"html_url\": \"https://gist.github.com/aa5a315d61ae9438b18d\",\n    \"files\": {\n      \"hello_world.rb\": {\n        \"filename\": \"hello_world.rb\",\n        \"type\": \"application/x-ruby\",\n        \"language\": \"Ruby\",\n        \"raw_url\": \"https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb\",\n        \"size\": 167\n      }\n    },\n    \"public\": true,\n    \"created_at\": \"2010-04-14T02:15:15Z\",\n    \"updated_at\": \"2011-06-20T11:34:15Z\",\n    \"description\": \"Hello World Examples\",\n    \"comments\": 1,\n    \"user\": null,\n    \"comments_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\",\n    \"owner\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    }\n  }\n]\n
" }, { "httpStatusCode": "304", @@ -21357,7 +21357,7 @@ } ], "summary": "Create a discussion", - "description": "Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\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**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`.", + "description": "Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`.", "tags": [ "teams" ], @@ -21434,7 +21434,7 @@ "subcategory": "discussions", "subcategoryLabel": "Discussions", "notes": [], - "descriptionHTML": "

Creates a new discussion post on a team's page. OAuth access tokens require the write:discussion scope.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

\n

Note: You can also specify a team by org_id and team_id using the route POST /organizations/{org_id}/team/{team_id}/discussions.

", + "descriptionHTML": "

Creates a new discussion post on a team's page. OAuth access tokens require the write:discussion scope.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

\n

Note: You can also specify a team by org_id and team_id using the route POST /organizations/{org_id}/team/{team_id}/discussions.

", "bodyParameters": [ { "type": "string", @@ -21947,7 +21947,7 @@ } ], "summary": "Create a discussion comment", - "description": "Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\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**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.", + "description": "Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.", "tags": [ "teams" ], @@ -22003,7 +22003,7 @@ "subcategory": "discussion-comments", "subcategoryLabel": "Discussion comments", "notes": [], - "descriptionHTML": "

Creates a new comment on a team discussion. OAuth access tokens require the write:discussion scope.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

\n

Note: You can also specify a team by org_id and team_id using the route POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments.

", + "descriptionHTML": "

Creates a new comment on a team discussion. OAuth access tokens require the write:discussion scope.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

\n

Note: You can also specify a team by org_id and team_id using the route POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments.

", "bodyParameters": [ { "type": "string", @@ -40899,7 +40899,7 @@ } ], "summary": "Add a repository collaborator", - "description": "This 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\nFor more information the permission levels, see \"[Repository permission levels for an organization](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@2.22/rest/overview/resources-in-the-rest-api#http-verbs).\"\n\nThe invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [repository invitations API endpoints](https://docs.github.com/enterprise-server@2.22/rest/reference/repos#invitations).\n\n**Rate limits**\n\nTo prevent abuse, you are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.", + "description": "This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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\nFor more information the permission levels, see \"[Repository permission levels for an organization](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@2.22/rest/overview/resources-in-the-rest-api#http-verbs).\"\n\nThe invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [repository invitations API endpoints](https://docs.github.com/enterprise-server@2.22/rest/reference/repos#invitations).\n\n**Rate limits**\n\nTo prevent abuse, you are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.", "tags": [ "repos" ], @@ -40959,7 +40959,7 @@ "subcategory": "collaborators", "subcategoryLabel": "Collaborators", "notes": [], - "descriptionHTML": "

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

\n

For more information the permission levels, see \"Repository permission levels for an organization\".

\n

Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"

\n

The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the repository invitations API endpoints.

\n

Rate limits

\n

To prevent abuse, you are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.

", + "descriptionHTML": "

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

\n

For more information the permission levels, see \"Repository permission levels for an organization\".

\n

Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"

\n

The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the repository invitations API endpoints.

\n

Rate limits

\n

To prevent abuse, you are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.

", "bodyParameters": [ { "type": "string", @@ -42364,7 +42364,7 @@ } ], "summary": "Create a commit comment", - "description": "Create a comment for a commit using its `:commit_sha`.\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.", + "description": "Create a comment for a commit using its `:commit_sha`.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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": [ "repos" ], @@ -42443,7 +42443,7 @@ "subcategory": "comments", "subcategoryLabel": "Comments", "notes": [], - "descriptionHTML": "

Create a comment for a commit using its :commit_sha.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", + "descriptionHTML": "

Create a comment for a commit using its :commit_sha.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", "bodyParameters": [ { "type": "string", @@ -50289,7 +50289,7 @@ } ], "summary": "Create an issue", - "description": "Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://help.github.com/articles/disabling-issues/), the API returns a `410 Gone` status.\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-abuse-rate-limits)\" for details.", + "description": "Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://help.github.com/articles/disabling-issues/), the API returns a `410 Gone` status.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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-abuse-rate-limits)\" for details.", "tags": [ "issues" ], @@ -50418,7 +50418,7 @@ "category": "issues", "categoryLabel": "Issues", "notes": [], - "descriptionHTML": "

Any user with pull access to a repository can create an issue. If issues are disabled in the repository, the API returns a 410 Gone status.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", + "descriptionHTML": "

Any user with pull access to a repository can create an issue. If issues are disabled in the repository, the API returns a 410 Gone status.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", "bodyParameters": [ { "type": "string", @@ -52409,7 +52409,7 @@ } ], "summary": "Create an issue comment", - "description": "This 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-abuse-rate-limits)\" for details.", + "description": "This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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-abuse-rate-limits)\" for details.", "tags": [ "issues" ], @@ -52458,7 +52458,7 @@ "subcategory": "comments", "subcategoryLabel": "Comments", "notes": [], - "descriptionHTML": "

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", + "descriptionHTML": "

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", "bodyParameters": [ { "type": "string", @@ -57986,7 +57986,7 @@ } ], "summary": "Create a pull request", - "description": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.\n\nYou can create a new pull request.\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.", + "description": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.\n\nYou can create a new pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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" ], @@ -58091,7 +58091,7 @@ "category": "pulls", "categoryLabel": "Pulls", "notes": [], - "descriptionHTML": "

Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

\n

To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.

\n

You can create a new pull request.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", + "descriptionHTML": "

Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

\n

To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.

\n

You can create a new pull request.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", "bodyParameters": [ { "type": "string", @@ -59500,7 +59500,7 @@ } ], "summary": "Create a review comment for a pull request", - "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.", + "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://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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" ], @@ -59659,7 +59659,7 @@ "subcategory": "comments", "subcategoryLabel": "Comments", "notes": [], - "descriptionHTML": "

Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"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

You 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.

\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

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", + "descriptionHTML": "

Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"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

You 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.

\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

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", "bodyParameters": [ { "type": "string", @@ -59827,7 +59827,7 @@ } ], "summary": "Create a reply for a review comment", - "description": "Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported.\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.", + "description": "Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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" ], @@ -59876,7 +59876,7 @@ "subcategory": "comments", "subcategoryLabel": "Comments", "notes": [], - "descriptionHTML": "

Creates a reply to a review comment for a pull request. For the comment_id, provide the ID of the review comment you are replying to. This must be the ID of a top-level review comment, not a reply to that comment. Replies to replies are not supported.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", + "descriptionHTML": "

Creates a reply to a review comment for a pull request. For the comment_id, provide the ID of the review comment you are replying to. This must be the ID of a top-level review comment, not a reply to that comment. Replies to replies are not supported.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", "bodyParameters": [ { "type": "string", @@ -60943,7 +60943,7 @@ } ], "summary": "Create a review for a pull request", - "description": "This 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\nPull request reviews created in the `PENDING` state do not include the `submitted_at` property in the response.\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API v3 offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/enterprise-server@2.22/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/enterprise-server@2.22/rest/reference/pulls#get-a-pull-request) endpoint.\n\nThe `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.", + "description": "This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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\nPull request reviews created in the `PENDING` state do not include the `submitted_at` property in the response.\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API v3 offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/enterprise-server@2.22/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/enterprise-server@2.22/rest/reference/pulls#get-a-pull-request) endpoint.\n\nThe `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.", "tags": [ "pulls" ], @@ -61173,7 +61173,7 @@ "subcategory": "reviews", "subcategoryLabel": "Reviews", "notes": [], - "descriptionHTML": "

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

\n

Pull request reviews created in the PENDING state do not include the submitted_at property in the response.

\n

Note: To comment on a specific line in a file, you need to first determine the position of that line in the diff. The GitHub REST API v3 offers the application/vnd.github.v3.diff media type. To see a pull request diff, add this media type to the Accept header of a call to the single pull request endpoint.

\n

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.

", + "descriptionHTML": "

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

\n

Pull request reviews created in the PENDING state do not include the submitted_at property in the response.

\n

Note: To comment on a specific line in a file, you need to first determine the position of that line in the diff. The GitHub REST API v3 offers the application/vnd.github.v3.diff media type. To see a pull request diff, add this media type to the Accept header of a call to the single pull request endpoint.

\n

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.

", "responses": [ { "httpStatusCode": "200", @@ -62485,7 +62485,7 @@ } ], "summary": "Create a release", - "description": "Users with push access to the repository can create a release.\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.", + "description": "Users with push access to the repository can create a release.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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": [ "repos" ], @@ -62586,7 +62586,7 @@ "subcategory": "releases", "subcategoryLabel": "Releases", "notes": [], - "descriptionHTML": "

Users with push access to the repository can create a release.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", + "descriptionHTML": "

Users with push access to the repository can create a release.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", "bodyParameters": [ { "type": "string", @@ -67943,7 +67943,7 @@ } ], "summary": "Create a discussion (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/enterprise-server@2.22/rest/reference/teams#create-a-discussion) endpoint.\n\nCreates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\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.", + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/enterprise-server@2.22/rest/reference/teams#create-a-discussion) endpoint.\n\nCreates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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": [ "teams" ], @@ -68023,7 +68023,7 @@ "subcategory": "discussions", "subcategoryLabel": "Discussions", "notes": [], - "descriptionHTML": "

Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create a discussion endpoint.

\n

Creates a new discussion post on a team's page. OAuth access tokens require the write:discussion scope.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", + "descriptionHTML": "

Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create a discussion endpoint.

\n

Creates a new discussion post on a team's page. OAuth access tokens require the write:discussion scope.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", "bodyParameters": [ { "type": "string", @@ -68498,7 +68498,7 @@ } ], "summary": "Create a discussion comment (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/enterprise-server@2.22/rest/reference/teams#create-a-discussion-comment) endpoint.\n\nCreates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\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.", + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/enterprise-server@2.22/rest/reference/teams#create-a-discussion-comment) endpoint.\n\nCreates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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": [ "teams" ], @@ -68557,7 +68557,7 @@ "subcategory": "discussion-comments", "subcategoryLabel": "Discussion comments", "notes": [], - "descriptionHTML": "

Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create a discussion comment endpoint.

\n

Creates a new comment on a team discussion. OAuth access tokens require the write:discussion scope.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", + "descriptionHTML": "

Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create a discussion comment endpoint.

\n

Creates a new comment on a team discussion. OAuth access tokens require the write:discussion scope.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", "bodyParameters": [ { "type": "string", diff --git a/lib/rest/static/decorated/ghes-3.0.json b/lib/rest/static/decorated/ghes-3.0.json index d88f173d24..e699b7d5c0 100644 --- a/lib/rest/static/decorated/ghes-3.0.json +++ b/lib/rest/static/decorated/ghes-3.0.json @@ -14443,7 +14443,7 @@ "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Default response", - "payload": "
[\n  {\n    \"url\": \"https://api.github.com/gists/dee9c42e4998ce2ea439\",\n    \"id\": \"dee9c42e4998ce2ea439\",\n    \"created_at\": \"2011-04-14T16:00:49Z\",\n    \"updated_at\": \"2011-04-14T16:00:49Z\"\n  }\n]\n
" + "payload": "
[\n  {\n    \"url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d\",\n    \"forks_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\n    \"commits_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\n    \"id\": \"aa5a315d61ae9438b18d\",\n    \"node_id\": \"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\n    \"git_pull_url\": \"https://gist.github.com/aa5a315d61ae9438b18d.git\",\n    \"git_push_url\": \"https://gist.github.com/aa5a315d61ae9438b18d.git\",\n    \"html_url\": \"https://gist.github.com/aa5a315d61ae9438b18d\",\n    \"files\": {\n      \"hello_world.rb\": {\n        \"filename\": \"hello_world.rb\",\n        \"type\": \"application/x-ruby\",\n        \"language\": \"Ruby\",\n        \"raw_url\": \"https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb\",\n        \"size\": 167\n      }\n    },\n    \"public\": true,\n    \"created_at\": \"2010-04-14T02:15:15Z\",\n    \"updated_at\": \"2011-06-20T11:34:15Z\",\n    \"description\": \"Hello World Examples\",\n    \"comments\": 1,\n    \"user\": null,\n    \"comments_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\",\n    \"owner\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    }\n  }\n]\n
" }, { "httpStatusCode": "304", @@ -25264,7 +25264,7 @@ } ], "summary": "Create a discussion", - "description": "Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@3.0/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\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@3.0/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@3.0/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`.", + "description": "Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@3.0/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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@3.0/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@3.0/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`.", "tags": [ "teams" ], @@ -25341,7 +25341,7 @@ "subcategory": "discussions", "subcategoryLabel": "Discussions", "notes": [], - "descriptionHTML": "

Creates a new discussion post on a team's page. OAuth access tokens require the write:discussion scope.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

\n

Note: You can also specify a team by org_id and team_id using the route POST /organizations/{org_id}/team/{team_id}/discussions.

", + "descriptionHTML": "

Creates a new discussion post on a team's page. OAuth access tokens require the write:discussion scope.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

\n

Note: You can also specify a team by org_id and team_id using the route POST /organizations/{org_id}/team/{team_id}/discussions.

", "bodyParameters": [ { "type": "string", @@ -25854,7 +25854,7 @@ } ], "summary": "Create a discussion comment", - "description": "Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@3.0/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\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@3.0/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@3.0/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.", + "description": "Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@3.0/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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@3.0/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@3.0/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.", "tags": [ "teams" ], @@ -25910,7 +25910,7 @@ "subcategory": "discussion-comments", "subcategoryLabel": "Discussion comments", "notes": [], - "descriptionHTML": "

Creates a new comment on a team discussion. OAuth access tokens require the write:discussion scope.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

\n

Note: You can also specify a team by org_id and team_id using the route POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments.

", + "descriptionHTML": "

Creates a new comment on a team discussion. OAuth access tokens require the write:discussion scope.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

\n

Note: You can also specify a team by org_id and team_id using the route POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments.

", "bodyParameters": [ { "type": "string", @@ -45328,7 +45328,7 @@ } ], "summary": "Add a repository collaborator", - "description": "This 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@3.0/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@3.0/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\nFor more information the permission levels, see \"[Repository permission levels for an organization](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@3.0/rest/overview/resources-in-the-rest-api#http-verbs).\"\n\nThe invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [repository invitations API endpoints](https://docs.github.com/enterprise-server@3.0/rest/reference/repos#invitations).\n\n**Rate limits**\n\nTo prevent abuse, you are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.", + "description": "This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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@3.0/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@3.0/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\nFor more information the permission levels, see \"[Repository permission levels for an organization](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@3.0/rest/overview/resources-in-the-rest-api#http-verbs).\"\n\nThe invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [repository invitations API endpoints](https://docs.github.com/enterprise-server@3.0/rest/reference/repos#invitations).\n\n**Rate limits**\n\nTo prevent abuse, you are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.", "tags": [ "repos" ], @@ -45388,7 +45388,7 @@ "subcategory": "collaborators", "subcategoryLabel": "Collaborators", "notes": [], - "descriptionHTML": "

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

\n

For more information the permission levels, see \"Repository permission levels for an organization\".

\n

Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"

\n

The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the repository invitations API endpoints.

\n

Rate limits

\n

To prevent abuse, you are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.

", + "descriptionHTML": "

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

\n

For more information the permission levels, see \"Repository permission levels for an organization\".

\n

Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"

\n

The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the repository invitations API endpoints.

\n

Rate limits

\n

To prevent abuse, you are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.

", "bodyParameters": [ { "type": "string", @@ -46793,7 +46793,7 @@ } ], "summary": "Create a commit comment", - "description": "Create a comment for a commit using its `:commit_sha`.\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@3.0/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@3.0/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", + "description": "Create a comment for a commit using its `:commit_sha`.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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@3.0/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@3.0/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", "tags": [ "repos" ], @@ -46872,7 +46872,7 @@ "subcategory": "comments", "subcategoryLabel": "Comments", "notes": [], - "descriptionHTML": "

Create a comment for a commit using its :commit_sha.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", + "descriptionHTML": "

Create a comment for a commit using its :commit_sha.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", "bodyParameters": [ { "type": "string", @@ -54962,7 +54962,7 @@ } ], "summary": "Create an issue", - "description": "Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://help.github.com/articles/disabling-issues/), the API returns a `410 Gone` status.\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@3.0/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@3.0/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)\" for details.", + "description": "Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://help.github.com/articles/disabling-issues/), the API returns a `410 Gone` status.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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@3.0/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@3.0/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)\" for details.", "tags": [ "issues" ], @@ -55091,7 +55091,7 @@ "category": "issues", "categoryLabel": "Issues", "notes": [], - "descriptionHTML": "

Any user with pull access to a repository can create an issue. If issues are disabled in the repository, the API returns a 410 Gone status.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", + "descriptionHTML": "

Any user with pull access to a repository can create an issue. If issues are disabled in the repository, the API returns a 410 Gone status.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", "bodyParameters": [ { "type": "string", @@ -57082,7 +57082,7 @@ } ], "summary": "Create an issue comment", - "description": "This 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@3.0/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@3.0/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)\" for details.", + "description": "This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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@3.0/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@3.0/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)\" for details.", "tags": [ "issues" ], @@ -57131,7 +57131,7 @@ "subcategory": "comments", "subcategoryLabel": "Comments", "notes": [], - "descriptionHTML": "

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", + "descriptionHTML": "

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", "bodyParameters": [ { "type": "string", @@ -62659,7 +62659,7 @@ } ], "summary": "Create a pull request", - "description": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.\n\nYou can create a new pull request.\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@3.0/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@3.0/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", + "description": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.\n\nYou can create a new pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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@3.0/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@3.0/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", "tags": [ "pulls" ], @@ -62764,7 +62764,7 @@ "category": "pulls", "categoryLabel": "Pulls", "notes": [], - "descriptionHTML": "

Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

\n

To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.

\n

You can create a new pull request.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", + "descriptionHTML": "

Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

\n

To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.

\n

You can create a new pull request.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", "bodyParameters": [ { "type": "string", @@ -64173,7 +64173,7 @@ } ], "summary": "Create a review comment for a pull request", - "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@3.0/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@3.0/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@3.0/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@3.0/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", + "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@3.0/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@3.0/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://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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@3.0/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@3.0/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", "tags": [ "pulls" ], @@ -64332,7 +64332,7 @@ "subcategory": "comments", "subcategoryLabel": "Comments", "notes": [], - "descriptionHTML": "

Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"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

You 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.

\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

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", + "descriptionHTML": "

Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"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

You 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.

\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

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", "bodyParameters": [ { "type": "string", @@ -64500,7 +64500,7 @@ } ], "summary": "Create a reply for a review comment", - "description": "Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported.\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@3.0/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@3.0/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", + "description": "Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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@3.0/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@3.0/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", "tags": [ "pulls" ], @@ -64549,7 +64549,7 @@ "subcategory": "comments", "subcategoryLabel": "Comments", "notes": [], - "descriptionHTML": "

Creates a reply to a review comment for a pull request. For the comment_id, provide the ID of the review comment you are replying to. This must be the ID of a top-level review comment, not a reply to that comment. Replies to replies are not supported.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", + "descriptionHTML": "

Creates a reply to a review comment for a pull request. For the comment_id, provide the ID of the review comment you are replying to. This must be the ID of a top-level review comment, not a reply to that comment. Replies to replies are not supported.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", "bodyParameters": [ { "type": "string", @@ -65616,7 +65616,7 @@ } ], "summary": "Create a review for a pull request", - "description": "This 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@3.0/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@3.0/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\nPull request reviews created in the `PENDING` state do not include the `submitted_at` property in the response.\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API v3 offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/enterprise-server@3.0/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/enterprise-server@3.0/rest/reference/pulls#get-a-pull-request) endpoint.\n\nThe `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.", + "description": "This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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@3.0/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@3.0/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\nPull request reviews created in the `PENDING` state do not include the `submitted_at` property in the response.\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API v3 offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/enterprise-server@3.0/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/enterprise-server@3.0/rest/reference/pulls#get-a-pull-request) endpoint.\n\nThe `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.", "tags": [ "pulls" ], @@ -65846,7 +65846,7 @@ "subcategory": "reviews", "subcategoryLabel": "Reviews", "notes": [], - "descriptionHTML": "

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

\n

Pull request reviews created in the PENDING state do not include the submitted_at property in the response.

\n

Note: To comment on a specific line in a file, you need to first determine the position of that line in the diff. The GitHub REST API v3 offers the application/vnd.github.v3.diff media type. To see a pull request diff, add this media type to the Accept header of a call to the single pull request endpoint.

\n

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.

", + "descriptionHTML": "

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

\n

Pull request reviews created in the PENDING state do not include the submitted_at property in the response.

\n

Note: To comment on a specific line in a file, you need to first determine the position of that line in the diff. The GitHub REST API v3 offers the application/vnd.github.v3.diff media type. To see a pull request diff, add this media type to the Accept header of a call to the single pull request endpoint.

\n

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.

", "responses": [ { "httpStatusCode": "200", @@ -67158,7 +67158,7 @@ } ], "summary": "Create a release", - "description": "Users with push access to the repository can create a release.\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@3.0/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@3.0/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", + "description": "Users with push access to the repository can create a release.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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@3.0/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@3.0/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", "tags": [ "repos" ], @@ -67259,7 +67259,7 @@ "subcategory": "releases", "subcategoryLabel": "Releases", "notes": [], - "descriptionHTML": "

Users with push access to the repository can create a release.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", + "descriptionHTML": "

Users with push access to the repository can create a release.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", "bodyParameters": [ { "type": "string", @@ -72616,7 +72616,7 @@ } ], "summary": "Create a discussion (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/enterprise-server@3.0/rest/reference/teams#create-a-discussion) endpoint.\n\nCreates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@3.0/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\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@3.0/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@3.0/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/enterprise-server@3.0/rest/reference/teams#create-a-discussion) endpoint.\n\nCreates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@3.0/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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@3.0/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@3.0/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", "tags": [ "teams" ], @@ -72696,7 +72696,7 @@ "subcategory": "discussions", "subcategoryLabel": "Discussions", "notes": [], - "descriptionHTML": "

Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create a discussion endpoint.

\n

Creates a new discussion post on a team's page. OAuth access tokens require the write:discussion scope.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", + "descriptionHTML": "

Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create a discussion endpoint.

\n

Creates a new discussion post on a team's page. OAuth access tokens require the write:discussion scope.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", "bodyParameters": [ { "type": "string", @@ -73171,7 +73171,7 @@ } ], "summary": "Create a discussion comment (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/enterprise-server@3.0/rest/reference/teams#create-a-discussion-comment) endpoint.\n\nCreates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@3.0/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\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@3.0/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@3.0/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/enterprise-server@3.0/rest/reference/teams#create-a-discussion-comment) endpoint.\n\nCreates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@3.0/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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@3.0/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@3.0/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", "tags": [ "teams" ], @@ -73230,7 +73230,7 @@ "subcategory": "discussion-comments", "subcategoryLabel": "Discussion comments", "notes": [], - "descriptionHTML": "

Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create a discussion comment endpoint.

\n

Creates a new comment on a team discussion. OAuth access tokens require the write:discussion scope.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", + "descriptionHTML": "

Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create a discussion comment endpoint.

\n

Creates a new comment on a team discussion. OAuth access tokens require the write:discussion scope.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", "bodyParameters": [ { "type": "string", diff --git a/lib/rest/static/decorated/github.ae.json b/lib/rest/static/decorated/github.ae.json index ae4350c5bd..9df1c4256d 100644 --- a/lib/rest/static/decorated/github.ae.json +++ b/lib/rest/static/decorated/github.ae.json @@ -7981,7 +7981,7 @@ "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Default response", - "payload": "
[\n  {\n    \"url\": \"https://api.github.com/gists/dee9c42e4998ce2ea439\",\n    \"id\": \"dee9c42e4998ce2ea439\",\n    \"created_at\": \"2011-04-14T16:00:49Z\",\n    \"updated_at\": \"2011-04-14T16:00:49Z\"\n  }\n]\n
" + "payload": "
[\n  {\n    \"url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d\",\n    \"forks_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\n    \"commits_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\n    \"id\": \"aa5a315d61ae9438b18d\",\n    \"node_id\": \"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\n    \"git_pull_url\": \"https://gist.github.com/aa5a315d61ae9438b18d.git\",\n    \"git_push_url\": \"https://gist.github.com/aa5a315d61ae9438b18d.git\",\n    \"html_url\": \"https://gist.github.com/aa5a315d61ae9438b18d\",\n    \"files\": {\n      \"hello_world.rb\": {\n        \"filename\": \"hello_world.rb\",\n        \"type\": \"application/x-ruby\",\n        \"language\": \"Ruby\",\n        \"raw_url\": \"https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb\",\n        \"size\": 167\n      }\n    },\n    \"public\": true,\n    \"created_at\": \"2010-04-14T02:15:15Z\",\n    \"updated_at\": \"2011-06-20T11:34:15Z\",\n    \"description\": \"Hello World Examples\",\n    \"comments\": 1,\n    \"user\": null,\n    \"comments_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\",\n    \"owner\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    }\n  }\n]\n
" }, { "httpStatusCode": "304", @@ -15239,7 +15239,7 @@ } ], "summary": "Create a discussion", - "description": "Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\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**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`.", + "description": "Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`.", "tags": [ "teams" ], @@ -15316,7 +15316,7 @@ "subcategory": "discussions", "subcategoryLabel": "Discussions", "notes": [], - "descriptionHTML": "

Creates a new discussion post on a team's page. OAuth access tokens require the write:discussion scope.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

\n

Note: You can also specify a team by org_id and team_id using the route POST /organizations/{org_id}/team/{team_id}/discussions.

", + "descriptionHTML": "

Creates a new discussion post on a team's page. OAuth access tokens require the write:discussion scope.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

\n

Note: You can also specify a team by org_id and team_id using the route POST /organizations/{org_id}/team/{team_id}/discussions.

", "bodyParameters": [ { "type": "string", @@ -15829,7 +15829,7 @@ } ], "summary": "Create a discussion comment", - "description": "Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\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**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.", + "description": "Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.", "tags": [ "teams" ], @@ -15885,7 +15885,7 @@ "subcategory": "discussion-comments", "subcategoryLabel": "Discussion comments", "notes": [], - "descriptionHTML": "

Creates a new comment on a team discussion. OAuth access tokens require the write:discussion scope.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

\n

Note: You can also specify a team by org_id and team_id using the route POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments.

", + "descriptionHTML": "

Creates a new comment on a team discussion. OAuth access tokens require the write:discussion scope.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

\n

Note: You can also specify a team by org_id and team_id using the route POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments.

", "bodyParameters": [ { "type": "string", @@ -31316,7 +31316,7 @@ } ], "summary": "Add a repository collaborator", - "description": "This 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\nFor more information the permission levels, see \"[Repository permission levels for an organization](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#http-verbs).\"\n\nThe invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [repository invitations API endpoints](https://docs.github.com/github-ae@latest/rest/reference/repos#invitations).\n\n**Rate limits**\n\nTo prevent abuse, you are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.", + "description": "This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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\nFor more information the permission levels, see \"[Repository permission levels for an organization](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#http-verbs).\"\n\nThe invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [repository invitations API endpoints](https://docs.github.com/github-ae@latest/rest/reference/repos#invitations).\n\n**Rate limits**\n\nTo prevent abuse, you are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.", "tags": [ "repos" ], @@ -31376,7 +31376,7 @@ "subcategory": "collaborators", "subcategoryLabel": "Collaborators", "notes": [], - "descriptionHTML": "

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

\n

For more information the permission levels, see \"Repository permission levels for an organization\".

\n

Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"

\n

The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the repository invitations API endpoints.

\n

Rate limits

\n

To prevent abuse, you are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.

", + "descriptionHTML": "

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

\n

For more information the permission levels, see \"Repository permission levels for an organization\".

\n

Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"

\n

The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the repository invitations API endpoints.

\n

Rate limits

\n

To prevent abuse, you are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.

", "bodyParameters": [ { "type": "string", @@ -32781,7 +32781,7 @@ } ], "summary": "Create a commit comment", - "description": "Create a comment for a commit using its `:commit_sha`.\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.", + "description": "Create a comment for a commit using its `:commit_sha`.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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": [ "repos" ], @@ -32860,7 +32860,7 @@ "subcategory": "comments", "subcategoryLabel": "Comments", "notes": [], - "descriptionHTML": "

Create a comment for a commit using its :commit_sha.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", + "descriptionHTML": "

Create a comment for a commit using its :commit_sha.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", "bodyParameters": [ { "type": "string", @@ -40950,7 +40950,7 @@ } ], "summary": "Create an issue", - "description": "Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://help.github.com/articles/disabling-issues/), the API returns a `410 Gone` status.\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-abuse-rate-limits)\" for details.", + "description": "Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://help.github.com/articles/disabling-issues/), the API returns a `410 Gone` status.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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-abuse-rate-limits)\" for details.", "tags": [ "issues" ], @@ -41079,7 +41079,7 @@ "category": "issues", "categoryLabel": "Issues", "notes": [], - "descriptionHTML": "

Any user with pull access to a repository can create an issue. If issues are disabled in the repository, the API returns a 410 Gone status.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", + "descriptionHTML": "

Any user with pull access to a repository can create an issue. If issues are disabled in the repository, the API returns a 410 Gone status.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", "bodyParameters": [ { "type": "string", @@ -43070,7 +43070,7 @@ } ], "summary": "Create an issue comment", - "description": "This 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-abuse-rate-limits)\" for details.", + "description": "This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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-abuse-rate-limits)\" for details.", "tags": [ "issues" ], @@ -43119,7 +43119,7 @@ "subcategory": "comments", "subcategoryLabel": "Comments", "notes": [], - "descriptionHTML": "

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", + "descriptionHTML": "

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", "bodyParameters": [ { "type": "string", @@ -48259,7 +48259,7 @@ } ], "summary": "Create a pull request", - "description": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.\n\nYou can create a new pull request.\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.", + "description": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.\n\nYou can create a new pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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" ], @@ -48364,7 +48364,7 @@ "category": "pulls", "categoryLabel": "Pulls", "notes": [], - "descriptionHTML": "

Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

\n

To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.

\n

You can create a new pull request.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", + "descriptionHTML": "

Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

\n

To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.

\n

You can create a new pull request.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", "bodyParameters": [ { "type": "string", @@ -49773,7 +49773,7 @@ } ], "summary": "Create a review comment for a pull request", - "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.", + "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://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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" ], @@ -49932,7 +49932,7 @@ "subcategory": "comments", "subcategoryLabel": "Comments", "notes": [], - "descriptionHTML": "

Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"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

You 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.

\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

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", + "descriptionHTML": "

Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"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

You 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.

\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

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", "bodyParameters": [ { "type": "string", @@ -50100,7 +50100,7 @@ } ], "summary": "Create a reply for a review comment", - "description": "Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported.\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.", + "description": "Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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" ], @@ -50149,7 +50149,7 @@ "subcategory": "comments", "subcategoryLabel": "Comments", "notes": [], - "descriptionHTML": "

Creates a reply to a review comment for a pull request. For the comment_id, provide the ID of the review comment you are replying to. This must be the ID of a top-level review comment, not a reply to that comment. Replies to replies are not supported.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", + "descriptionHTML": "

Creates a reply to a review comment for a pull request. For the comment_id, provide the ID of the review comment you are replying to. This must be the ID of a top-level review comment, not a reply to that comment. Replies to replies are not supported.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", "bodyParameters": [ { "type": "string", @@ -51216,7 +51216,7 @@ } ], "summary": "Create a review for a pull request", - "description": "This 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\nPull request reviews created in the `PENDING` state do not include the `submitted_at` property in the response.\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API v3 offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/github-ae@latest/rest/reference/pulls#get-a-pull-request) endpoint.\n\nThe `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.", + "description": "This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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\nPull request reviews created in the `PENDING` state do not include the `submitted_at` property in the response.\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API v3 offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/github-ae@latest/rest/reference/pulls#get-a-pull-request) endpoint.\n\nThe `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.", "tags": [ "pulls" ], @@ -51446,7 +51446,7 @@ "subcategory": "reviews", "subcategoryLabel": "Reviews", "notes": [], - "descriptionHTML": "

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

\n

Pull request reviews created in the PENDING state do not include the submitted_at property in the response.

\n

Note: To comment on a specific line in a file, you need to first determine the position of that line in the diff. The GitHub REST API v3 offers the application/vnd.github.v3.diff media type. To see a pull request diff, add this media type to the Accept header of a call to the single pull request endpoint.

\n

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.

", + "descriptionHTML": "

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

\n

Pull request reviews created in the PENDING state do not include the submitted_at property in the response.

\n

Note: To comment on a specific line in a file, you need to first determine the position of that line in the diff. The GitHub REST API v3 offers the application/vnd.github.v3.diff media type. To see a pull request diff, add this media type to the Accept header of a call to the single pull request endpoint.

\n

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.

", "responses": [ { "httpStatusCode": "200", @@ -52758,7 +52758,7 @@ } ], "summary": "Create a release", - "description": "Users with push access to the repository can create a release.\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.", + "description": "Users with push access to the repository can create a release.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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": [ "repos" ], @@ -52859,7 +52859,7 @@ "subcategory": "releases", "subcategoryLabel": "Releases", "notes": [], - "descriptionHTML": "

Users with push access to the repository can create a release.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", + "descriptionHTML": "

Users with push access to the repository can create a release.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", "bodyParameters": [ { "type": "string", @@ -57412,7 +57412,7 @@ } ], "summary": "Create a discussion (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/github-ae@latest/rest/reference/teams#create-a-discussion) endpoint.\n\nCreates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\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.", + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/github-ae@latest/rest/reference/teams#create-a-discussion) endpoint.\n\nCreates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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": [ "teams" ], @@ -57492,7 +57492,7 @@ "subcategory": "discussions", "subcategoryLabel": "Discussions", "notes": [], - "descriptionHTML": "

Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create a discussion endpoint.

\n

Creates a new discussion post on a team's page. OAuth access tokens require the write:discussion scope.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", + "descriptionHTML": "

Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create a discussion endpoint.

\n

Creates a new discussion post on a team's page. OAuth access tokens require the write:discussion scope.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", "bodyParameters": [ { "type": "string", @@ -57967,7 +57967,7 @@ } ], "summary": "Create a discussion comment (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/github-ae@latest/rest/reference/teams#create-a-discussion-comment) endpoint.\n\nCreates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\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.", + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/github-ae@latest/rest/reference/teams#create-a-discussion-comment) endpoint.\n\nCreates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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": [ "teams" ], @@ -58026,7 +58026,7 @@ "subcategory": "discussion-comments", "subcategoryLabel": "Discussion comments", "notes": [], - "descriptionHTML": "

Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create a discussion comment endpoint.

\n

Creates a new comment on a team discussion. OAuth access tokens require the write:discussion scope.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", + "descriptionHTML": "

Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create a discussion comment endpoint.

\n

Creates a new comment on a team discussion. OAuth access tokens require the write:discussion scope.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", "bodyParameters": [ { "type": "string", diff --git a/lib/rest/static/dereferenced/api.github.com.deref.json b/lib/rest/static/dereferenced/api.github.com.deref.json index d02f87eac4..fc898bdb31 100644 --- a/lib/rest/static/dereferenced/api.github.com.deref.json +++ b/lib/rest/static/dereferenced/api.github.com.deref.json @@ -25401,641 +25401,203 @@ "content": { "application/json": { "schema": { - "title": "Gist Full", - "description": "Gist Full", - "allOf": [ - { - "title": "Gist Simple", - "description": "Gist Simple", + "title": "Gist Simple", + "description": "Gist Simple", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "id": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "git_pull_url": { + "type": "string" + }, + "git_push_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "files": { "type": "object", - "properties": { - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string" - }, - "git_push_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "files": { - "type": "object", - "additionalProperties": { - "nullable": true, - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "user": { - "type": "string", - "nullable": true - }, - "comments_url": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } + "additionalProperties": { + "nullable": true, + "type": "object", + "properties": { + "filename": { + "type": "string" }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "truncated": { - "type": "boolean" + "type": { + "type": "string" + }, + "language": { + "type": "string" + }, + "raw_url": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "truncated": { + "type": "boolean" + }, + "content": { + "type": "string" + } } } }, - { + "public": { + "type": "boolean" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "user": { + "type": "string", + "nullable": true + }, + "comments_url": { + "type": "string" + }, + "owner": { + "title": "Simple User", + "description": "Simple User", "type": "object", "properties": { - "forks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "user": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - } - }, - "url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - } - } - } - }, - "history": { - "type": "array", - "items": { - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "version": { - "type": "string" - }, - "user": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - }, - "nullable": true - }, - "change_status": { - "type": "object", - "properties": { - "deletions": { - "type": "integer" - }, - "additions": { - "type": "integer" - }, - "total": { - "type": "integer" - } - } - }, - "committed_at": { - "type": "string" - } - } - } - }, - "fork_of": { - "nullable": true, - "allOf": [ - { - "title": "Gist Simple", - "description": "Gist Simple", - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string" - }, - "git_push_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "files": { - "type": "object", - "additionalProperties": { - "nullable": true, - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "user": { - "type": "string", - "nullable": true - }, - "comments_url": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "truncated": { - "type": "boolean" - } - } - } - ] - }, - "url": { + "login": { "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/cb5b95fe0f15ada6d34a421007ba2e4a34e2771e\"" - }, - "forks_url": { - "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/forks\"" - }, - "commits_url": { - "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/commits\"" + "example": "octocat" }, "id": { - "type": "string", - "example": "\"d8de7663c84491ba9eeb9ca1fd20ced8\"" - }, - "node_id": { - "type": "string", - "example": "\"MDQ6R2lzdGQ4ZGU3NjYzYzg0NDkxYmE5ZWViOWNhMWZkMjBjZWQ4\"" - }, - "git_pull_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8.git\"" - }, - "git_push_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8.git\"" - }, - "html_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8\"" - }, - "created_at": { - "type": "string", - "example": "\"2020-07-09T00:18:06Z\"" - }, - "updated_at": { - "type": "string", - "example": "\"2020-07-09T00:18:06Z\"" - }, - "description": { - "type": "string", - "example": "\"description\"", - "nullable": true - }, - "comments": { "type": "integer", "example": 1 }, - "comments_url": { + "node_id": { "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/comments\"" + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" } - } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "truncated": { + "type": "boolean" } - ] + } }, "examples": { "default": { @@ -27299,641 +26861,203 @@ "content": { "application/json": { "schema": { - "title": "Gist Full", - "description": "Gist Full", - "allOf": [ - { - "title": "Gist Simple", - "description": "Gist Simple", + "title": "Gist Simple", + "description": "Gist Simple", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "id": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "git_pull_url": { + "type": "string" + }, + "git_push_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "files": { "type": "object", - "properties": { - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string" - }, - "git_push_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "files": { - "type": "object", - "additionalProperties": { - "nullable": true, - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "user": { - "type": "string", - "nullable": true - }, - "comments_url": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } + "additionalProperties": { + "nullable": true, + "type": "object", + "properties": { + "filename": { + "type": "string" }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "truncated": { - "type": "boolean" + "type": { + "type": "string" + }, + "language": { + "type": "string" + }, + "raw_url": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "truncated": { + "type": "boolean" + }, + "content": { + "type": "string" + } } } }, - { + "public": { + "type": "boolean" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "user": { + "type": "string", + "nullable": true + }, + "comments_url": { + "type": "string" + }, + "owner": { + "title": "Simple User", + "description": "Simple User", "type": "object", "properties": { - "forks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "user": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - } - }, - "url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - } - } - } - }, - "history": { - "type": "array", - "items": { - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "version": { - "type": "string" - }, - "user": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - }, - "nullable": true - }, - "change_status": { - "type": "object", - "properties": { - "deletions": { - "type": "integer" - }, - "additions": { - "type": "integer" - }, - "total": { - "type": "integer" - } - } - }, - "committed_at": { - "type": "string" - } - } - } - }, - "fork_of": { - "nullable": true, - "allOf": [ - { - "title": "Gist Simple", - "description": "Gist Simple", - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string" - }, - "git_push_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "files": { - "type": "object", - "additionalProperties": { - "nullable": true, - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "user": { - "type": "string", - "nullable": true - }, - "comments_url": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "truncated": { - "type": "boolean" - } - } - } - ] - }, - "url": { + "login": { "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/cb5b95fe0f15ada6d34a421007ba2e4a34e2771e\"" - }, - "forks_url": { - "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/forks\"" - }, - "commits_url": { - "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/commits\"" + "example": "octocat" }, "id": { - "type": "string", - "example": "\"d8de7663c84491ba9eeb9ca1fd20ced8\"" - }, - "node_id": { - "type": "string", - "example": "\"MDQ6R2lzdGQ4ZGU3NjYzYzg0NDkxYmE5ZWViOWNhMWZkMjBjZWQ4\"" - }, - "git_pull_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8.git\"" - }, - "git_push_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8.git\"" - }, - "html_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8\"" - }, - "created_at": { - "type": "string", - "example": "\"2020-07-09T00:18:06Z\"" - }, - "updated_at": { - "type": "string", - "example": "\"2020-07-09T00:18:06Z\"" - }, - "description": { - "type": "string", - "example": "\"description\"", - "nullable": true - }, - "comments": { "type": "integer", "example": 1 }, - "comments_url": { + "node_id": { "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/comments\"" + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" } - } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "truncated": { + "type": "boolean" } - ] + } }, "examples": { "default": { @@ -28107,641 +27231,203 @@ "content": { "application/json": { "schema": { - "title": "Gist Full", - "description": "Gist Full", - "allOf": [ - { - "title": "Gist Simple", - "description": "Gist Simple", + "title": "Gist Simple", + "description": "Gist Simple", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "id": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "git_pull_url": { + "type": "string" + }, + "git_push_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "files": { "type": "object", - "properties": { - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string" - }, - "git_push_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "files": { - "type": "object", - "additionalProperties": { - "nullable": true, - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "user": { - "type": "string", - "nullable": true - }, - "comments_url": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } + "additionalProperties": { + "nullable": true, + "type": "object", + "properties": { + "filename": { + "type": "string" }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "truncated": { - "type": "boolean" + "type": { + "type": "string" + }, + "language": { + "type": "string" + }, + "raw_url": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "truncated": { + "type": "boolean" + }, + "content": { + "type": "string" + } } } }, - { + "public": { + "type": "boolean" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "user": { + "type": "string", + "nullable": true + }, + "comments_url": { + "type": "string" + }, + "owner": { + "title": "Simple User", + "description": "Simple User", "type": "object", "properties": { - "forks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "user": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - } - }, - "url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - } - } - } - }, - "history": { - "type": "array", - "items": { - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "version": { - "type": "string" - }, - "user": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - }, - "nullable": true - }, - "change_status": { - "type": "object", - "properties": { - "deletions": { - "type": "integer" - }, - "additions": { - "type": "integer" - }, - "total": { - "type": "integer" - } - } - }, - "committed_at": { - "type": "string" - } - } - } - }, - "fork_of": { - "nullable": true, - "allOf": [ - { - "title": "Gist Simple", - "description": "Gist Simple", - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string" - }, - "git_push_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "files": { - "type": "object", - "additionalProperties": { - "nullable": true, - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "user": { - "type": "string", - "nullable": true - }, - "comments_url": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "truncated": { - "type": "boolean" - } - } - } - ] - }, - "url": { + "login": { "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/cb5b95fe0f15ada6d34a421007ba2e4a34e2771e\"" - }, - "forks_url": { - "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/forks\"" - }, - "commits_url": { - "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/commits\"" + "example": "octocat" }, "id": { - "type": "string", - "example": "\"d8de7663c84491ba9eeb9ca1fd20ced8\"" - }, - "node_id": { - "type": "string", - "example": "\"MDQ6R2lzdGQ4ZGU3NjYzYzg0NDkxYmE5ZWViOWNhMWZkMjBjZWQ4\"" - }, - "git_pull_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8.git\"" - }, - "git_push_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8.git\"" - }, - "html_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8\"" - }, - "created_at": { - "type": "string", - "example": "\"2020-07-09T00:18:06Z\"" - }, - "updated_at": { - "type": "string", - "example": "\"2020-07-09T00:18:06Z\"" - }, - "description": { - "type": "string", - "example": "\"description\"", - "nullable": true - }, - "comments": { "type": "integer", "example": 1 }, - "comments_url": { + "node_id": { "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/comments\"" + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" } - } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "truncated": { + "type": "boolean" } - ] + } }, "examples": { "default": { @@ -30617,651 +29303,253 @@ "schema": { "type": "array", "items": { - "title": "Gist Full", - "description": "Gist Full", - "allOf": [ - { - "title": "Gist Simple", - "description": "Gist Simple", + "title": "Gist Simple", + "description": "Gist Simple", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "id": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "git_pull_url": { + "type": "string" + }, + "git_push_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "files": { "type": "object", - "properties": { - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string" - }, - "git_push_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "files": { - "type": "object", - "additionalProperties": { - "nullable": true, - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "user": { - "type": "string", - "nullable": true - }, - "comments_url": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } + "additionalProperties": { + "nullable": true, + "type": "object", + "properties": { + "filename": { + "type": "string" }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "truncated": { - "type": "boolean" + "type": { + "type": "string" + }, + "language": { + "type": "string" + }, + "raw_url": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "truncated": { + "type": "boolean" + }, + "content": { + "type": "string" + } } } }, - { + "public": { + "type": "boolean" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "user": { + "type": "string", + "nullable": true + }, + "comments_url": { + "type": "string" + }, + "owner": { + "title": "Simple User", + "description": "Simple User", "type": "object", "properties": { - "forks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "user": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - } - }, - "url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - } - } - } - }, - "history": { - "type": "array", - "items": { - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "version": { - "type": "string" - }, - "user": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - }, - "nullable": true - }, - "change_status": { - "type": "object", - "properties": { - "deletions": { - "type": "integer" - }, - "additions": { - "type": "integer" - }, - "total": { - "type": "integer" - } - } - }, - "committed_at": { - "type": "string" - } - } - } - }, - "fork_of": { - "nullable": true, - "allOf": [ - { - "title": "Gist Simple", - "description": "Gist Simple", - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string" - }, - "git_push_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "files": { - "type": "object", - "additionalProperties": { - "nullable": true, - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "user": { - "type": "string", - "nullable": true - }, - "comments_url": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "truncated": { - "type": "boolean" - } - } - } - ] - }, - "url": { + "login": { "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/cb5b95fe0f15ada6d34a421007ba2e4a34e2771e\"" - }, - "forks_url": { - "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/forks\"" - }, - "commits_url": { - "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/commits\"" + "example": "octocat" }, "id": { - "type": "string", - "example": "\"d8de7663c84491ba9eeb9ca1fd20ced8\"" - }, - "node_id": { - "type": "string", - "example": "\"MDQ6R2lzdGQ4ZGU3NjYzYzg0NDkxYmE5ZWViOWNhMWZkMjBjZWQ4\"" - }, - "git_pull_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8.git\"" - }, - "git_push_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8.git\"" - }, - "html_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8\"" - }, - "created_at": { - "type": "string", - "example": "\"2020-07-09T00:18:06Z\"" - }, - "updated_at": { - "type": "string", - "example": "\"2020-07-09T00:18:06Z\"" - }, - "description": { - "type": "string", - "example": "\"description\"", - "nullable": true - }, - "comments": { "type": "integer", "example": 1 }, - "comments_url": { + "node_id": { "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/comments\"" + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" } - } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "truncated": { + "type": "boolean" } - ] + } } }, "examples": { "default": { "value": [ { - "url": "https://api.github.com/gists/dee9c42e4998ce2ea439", - "id": "dee9c42e4998ce2ea439", - "created_at": "2011-04-14T16:00:49Z", - "updated_at": "2011-04-14T16:00:49Z" + "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", + "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks", + "commits_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/commits", + "id": "aa5a315d61ae9438b18d", + "node_id": "MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk", + "git_pull_url": "https://gist.github.com/aa5a315d61ae9438b18d.git", + "git_push_url": "https://gist.github.com/aa5a315d61ae9438b18d.git", + "html_url": "https://gist.github.com/aa5a315d61ae9438b18d", + "files": { + "hello_world.rb": { + "filename": "hello_world.rb", + "type": "application/x-ruby", + "language": "Ruby", + "raw_url": "https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb", + "size": 167 + } + }, + "public": true, + "created_at": "2010-04-14T02:15:15Z", + "updated_at": "2011-06-20T11:34:15Z", + "description": "Hello World Examples", + "comments": 1, + "user": null, + "comments_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/comments/", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } } ] } @@ -32163,641 +30451,203 @@ "content": { "application/json": { "schema": { - "title": "Gist Full", - "description": "Gist Full", - "allOf": [ - { - "title": "Gist Simple", - "description": "Gist Simple", + "title": "Gist Simple", + "description": "Gist Simple", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "id": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "git_pull_url": { + "type": "string" + }, + "git_push_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "files": { "type": "object", - "properties": { - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string" - }, - "git_push_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "files": { - "type": "object", - "additionalProperties": { - "nullable": true, - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "user": { - "type": "string", - "nullable": true - }, - "comments_url": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } + "additionalProperties": { + "nullable": true, + "type": "object", + "properties": { + "filename": { + "type": "string" }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "truncated": { - "type": "boolean" + "type": { + "type": "string" + }, + "language": { + "type": "string" + }, + "raw_url": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "truncated": { + "type": "boolean" + }, + "content": { + "type": "string" + } } } }, - { + "public": { + "type": "boolean" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "user": { + "type": "string", + "nullable": true + }, + "comments_url": { + "type": "string" + }, + "owner": { + "title": "Simple User", + "description": "Simple User", "type": "object", "properties": { - "forks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "user": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - } - }, - "url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - } - } - } - }, - "history": { - "type": "array", - "items": { - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "version": { - "type": "string" - }, - "user": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - }, - "nullable": true - }, - "change_status": { - "type": "object", - "properties": { - "deletions": { - "type": "integer" - }, - "additions": { - "type": "integer" - }, - "total": { - "type": "integer" - } - } - }, - "committed_at": { - "type": "string" - } - } - } - }, - "fork_of": { - "nullable": true, - "allOf": [ - { - "title": "Gist Simple", - "description": "Gist Simple", - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string" - }, - "git_push_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "files": { - "type": "object", - "additionalProperties": { - "nullable": true, - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "user": { - "type": "string", - "nullable": true - }, - "comments_url": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "truncated": { - "type": "boolean" - } - } - } - ] - }, - "url": { + "login": { "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/cb5b95fe0f15ada6d34a421007ba2e4a34e2771e\"" - }, - "forks_url": { - "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/forks\"" - }, - "commits_url": { - "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/commits\"" + "example": "octocat" }, "id": { - "type": "string", - "example": "\"d8de7663c84491ba9eeb9ca1fd20ced8\"" - }, - "node_id": { - "type": "string", - "example": "\"MDQ6R2lzdGQ4ZGU3NjYzYzg0NDkxYmE5ZWViOWNhMWZkMjBjZWQ4\"" - }, - "git_pull_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8.git\"" - }, - "git_push_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8.git\"" - }, - "html_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8\"" - }, - "created_at": { - "type": "string", - "example": "\"2020-07-09T00:18:06Z\"" - }, - "updated_at": { - "type": "string", - "example": "\"2020-07-09T00:18:06Z\"" - }, - "description": { - "type": "string", - "example": "\"description\"", - "nullable": true - }, - "comments": { "type": "integer", "example": 1 }, - "comments_url": { + "node_id": { "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/comments\"" + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" } - } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "truncated": { + "type": "boolean" } - ] + } }, "examples": { "default": { @@ -60305,6 +58155,302 @@ } } }, + "/orgs/{org}/failed_invitations": { + "get": { + "summary": "List failed organization invitations", + "description": "The return hash contains `failed_at` and `failed_reason` fields which represent the time at which the invitation failed and the reason for the failure.", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-failed-invitations", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/orgs#list-failed-organization-invitations" + }, + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "Results per page (max 100)", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Organization Invitation", + "description": "Organization Invitation", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "login": { + "type": "string", + "nullable": true + }, + "email": { + "type": "string", + "nullable": true + }, + "role": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "failed_at": { + "type": "string" + }, + "failed_reason": { + "type": "string" + }, + "inviter": { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "team_count": { + "type": "integer" + }, + "invitation_team_url": { + "type": "string" + }, + "node_id": { + "type": "string", + "example": "\"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x\"" + }, + "invitation_teams_url": { + "type": "string", + "example": "\"https://api.github.com/organizations/16/invitations/1/teams\"" + } + }, + "required": [ + "id", + "login", + "email", + "role", + "created_at", + "inviter", + "team_count", + "invitation_team_url", + "node_id" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "id": 1, + "login": "monalisa", + "node_id": "MDQ6VXNlcjE=", + "email": "octocat@github.com", + "role": "direct_member", + "created_at": "2016-11-30T06:46:10-08:00", + "failed_at": "", + "failed_reason": "", + "inviter": { + "login": "other_user", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/other_user_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/other_user", + "html_url": "https://github.com/other_user", + "followers_url": "https://api.github.com/users/other_user/followers", + "following_url": "https://api.github.com/users/other_user/following{/other_user}", + "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}", + "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/other_user/subscriptions", + "organizations_url": "https://api.github.com/users/other_user/orgs", + "repos_url": "https://api.github.com/users/other_user/repos", + "events_url": "https://api.github.com/users/other_user/events{/privacy}", + "received_events_url": "https://api.github.com/users/other_user/received_events", + "type": "User", + "site_admin": false + }, + "team_count": 2, + "invitation_team_url": "https://api.github.com/organizations/2/invitations/1/teams" + } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + }, + "404": { + "description": "Resource Not Found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "orgs", + "subcategory": "members" + } + } + }, "/orgs/{org}/hooks": { "get": { "summary": "List organization webhooks", @@ -63166,6 +61312,12 @@ "created_at": { "type": "string" }, + "failed_at": { + "type": "string" + }, + "failed_reason": { + "type": "string" + }, "inviter": { "title": "Simple User", "description": "Simple User", @@ -63316,6 +61468,8 @@ "email": "octocat@github.com", "role": "direct_member", "created_at": "2016-11-30T06:46:10-08:00", + "failed_at": "", + "failed_reason": "", "inviter": { "login": "other_user", "id": 1, @@ -63386,7 +61540,7 @@ }, "post": { "summary": "Create an organization invitation", - "description": "Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner.\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.", + "description": "Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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": [ "orgs" ], @@ -63476,6 +61630,12 @@ "created_at": { "type": "string" }, + "failed_at": { + "type": "string" + }, + "failed_reason": { + "type": "string" + }, "inviter": { "title": "Simple User", "description": "Simple User", @@ -63754,6 +61914,143 @@ } } }, + "/orgs/{org}/invitations/{invitation_id}": { + "delete": { + "summary": "Cancel an organization invitation", + "description": "Cancel an organization invitation. In order to cancel an organization invitation, the authenticated user must be an organization owner.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications).", + "tags": [ + "orgs" + ], + "operationId": "orgs/cancel-invitation", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/orgs#cancel-an-organization-invitation" + }, + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "invitation_id", + "description": "invitation_id parameter", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Empty response" + }, + "422": { + "description": "Validation Failed", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + }, + "404": { + "description": "Resource Not Found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "orgs", + "subcategory": "members" + } + } + }, "/orgs/{org}/invitations/{invitation_id}/teams": { "get": { "summary": "List organization invitation teams", @@ -82030,7 +80327,7 @@ }, "post": { "summary": "Create a discussion", - "description": "Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\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**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`.", + "description": "Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`.", "tags": [ "teams" ], @@ -83681,7 +81978,7 @@ }, "post": { "summary": "Create a discussion comment", - "description": "Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\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**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.", + "description": "Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.", "tags": [ "teams" ], @@ -86254,6 +84551,12 @@ "created_at": { "type": "string" }, + "failed_at": { + "type": "string" + }, + "failed_reason": { + "type": "string" + }, "inviter": { "title": "Simple User", "description": "Simple User", @@ -86404,6 +84707,8 @@ "email": "octocat@github.com", "role": "direct_member", "created_at": "2016-11-30T06:46:10-08:00", + "failed_at": "", + "failed_reason": "", "inviter": { "login": "other_user", "id": 1, @@ -146143,7 +144448,7 @@ }, "put": { "summary": "Add a repository collaborator", - "description": "This 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\nFor more information the permission levels, see \"[Repository permission levels for an organization](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs).\"\n\nThe invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [repository invitations API endpoints](https://docs.github.com/rest/reference/repos#invitations).\n\n**Rate limits**\n\nTo prevent abuse, you are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.", + "description": "This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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\nFor more information the permission levels, see \"[Repository permission levels for an organization](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs).\"\n\nThe invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [repository invitations API endpoints](https://docs.github.com/rest/reference/repos#invitations).\n\n**Rate limits**\n\nTo prevent abuse, you are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.", "tags": [ "repos" ], @@ -151994,7 +150299,7 @@ }, "post": { "summary": "Create a commit comment", - "description": "Create a comment for a commit using its `:commit_sha`.\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.", + "description": "Create a comment for a commit using its `:commit_sha`.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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": [ "repos" ], @@ -190593,7 +188898,7 @@ }, "post": { "summary": "Create an issue", - "description": "Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://help.github.com/articles/disabling-issues/), the API returns a `410 Gone` status.\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-abuse-rate-limits)\" for details.", + "description": "Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://help.github.com/articles/disabling-issues/), the API returns a `410 Gone` status.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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-abuse-rate-limits)\" for details.", "tags": [ "issues" ], @@ -212813,7 +211118,7 @@ }, "post": { "summary": "Create an issue comment", - "description": "This 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-abuse-rate-limits)\" for details.", + "description": "This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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-abuse-rate-limits)\" for details.", "tags": [ "issues" ], @@ -228854,7 +227159,7 @@ }, "post": { "summary": "Create a pull request", - "description": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.\n\nYou can create a new pull request.\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.", + "description": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.\n\nYou can create a new pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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" ], @@ -241506,7 +239811,7 @@ }, "post": { "summary": "Create a review comment for a pull request", - "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.", + "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://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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" ], @@ -242184,7 +240489,7 @@ "/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies": { "post": { "summary": "Create a reply for a review comment", - "description": "Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported.\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.", + "description": "Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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" ], @@ -248764,7 +247069,7 @@ }, "post": { "summary": "Create a review for a pull request", - "description": "This 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\nPull request reviews created in the `PENDING` state do not include the `submitted_at` property in the response.\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API v3 offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/rest/reference/pulls#get-a-pull-request) endpoint.\n\nThe `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.", + "description": "This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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\nPull request reviews created in the `PENDING` state do not include the `submitted_at` property in the response.\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API v3 offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/rest/reference/pulls#get-a-pull-request) endpoint.\n\nThe `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.", "tags": [ "pulls" ], @@ -252645,7 +250950,7 @@ }, "post": { "summary": "Create a release", - "description": "Users with push access to the repository can create a release.\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.", + "description": "Users with push access to the repository can create a release.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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": [ "repos" ], @@ -281001,7 +279306,7 @@ }, "post": { "summary": "Create a discussion (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/reference/teams#create-a-discussion) endpoint.\n\nCreates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\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.", + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/reference/teams#create-a-discussion) endpoint.\n\nCreates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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": [ "teams" ], @@ -282622,7 +280927,7 @@ }, "post": { "summary": "Create a discussion comment (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/reference/teams#create-a-discussion-comment) endpoint.\n\nCreates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\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.", + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/reference/teams#create-a-discussion-comment) endpoint.\n\nCreates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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": [ "teams" ], @@ -284996,6 +283301,12 @@ "created_at": { "type": "string" }, + "failed_at": { + "type": "string" + }, + "failed_reason": { + "type": "string" + }, "inviter": { "title": "Simple User", "description": "Simple User", @@ -285146,6 +283457,8 @@ "email": "octocat@github.com", "role": "direct_member", "created_at": "2016-11-30T06:46:10-08:00", + "failed_at": "", + "failed_reason": "", "inviter": { "login": "other_user", "id": 1, diff --git a/lib/rest/static/dereferenced/ghes-2.18.deref.json b/lib/rest/static/dereferenced/ghes-2.18.deref.json index df00f4870a..828b51a681 100644 --- a/lib/rest/static/dereferenced/ghes-2.18.deref.json +++ b/lib/rest/static/dereferenced/ghes-2.18.deref.json @@ -21194,641 +21194,203 @@ "content": { "application/json": { "schema": { - "title": "Gist Full", - "description": "Gist Full", - "allOf": [ - { - "title": "Gist Simple", - "description": "Gist Simple", + "title": "Gist Simple", + "description": "Gist Simple", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "id": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "git_pull_url": { + "type": "string" + }, + "git_push_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "files": { "type": "object", - "properties": { - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string" - }, - "git_push_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "files": { - "type": "object", - "additionalProperties": { - "nullable": true, - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "user": { - "type": "string", - "nullable": true - }, - "comments_url": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } + "additionalProperties": { + "nullable": true, + "type": "object", + "properties": { + "filename": { + "type": "string" }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "truncated": { - "type": "boolean" + "type": { + "type": "string" + }, + "language": { + "type": "string" + }, + "raw_url": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "truncated": { + "type": "boolean" + }, + "content": { + "type": "string" + } } } }, - { + "public": { + "type": "boolean" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "user": { + "type": "string", + "nullable": true + }, + "comments_url": { + "type": "string" + }, + "owner": { + "title": "Simple User", + "description": "Simple User", "type": "object", "properties": { - "forks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "user": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - } - }, - "url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - } - } - } - }, - "history": { - "type": "array", - "items": { - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "version": { - "type": "string" - }, - "user": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - }, - "nullable": true - }, - "change_status": { - "type": "object", - "properties": { - "deletions": { - "type": "integer" - }, - "additions": { - "type": "integer" - }, - "total": { - "type": "integer" - } - } - }, - "committed_at": { - "type": "string" - } - } - } - }, - "fork_of": { - "nullable": true, - "allOf": [ - { - "title": "Gist Simple", - "description": "Gist Simple", - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string" - }, - "git_push_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "files": { - "type": "object", - "additionalProperties": { - "nullable": true, - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "user": { - "type": "string", - "nullable": true - }, - "comments_url": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "truncated": { - "type": "boolean" - } - } - } - ] - }, - "url": { + "login": { "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/cb5b95fe0f15ada6d34a421007ba2e4a34e2771e\"" - }, - "forks_url": { - "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/forks\"" - }, - "commits_url": { - "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/commits\"" + "example": "octocat" }, "id": { - "type": "string", - "example": "\"d8de7663c84491ba9eeb9ca1fd20ced8\"" - }, - "node_id": { - "type": "string", - "example": "\"MDQ6R2lzdGQ4ZGU3NjYzYzg0NDkxYmE5ZWViOWNhMWZkMjBjZWQ4\"" - }, - "git_pull_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8.git\"" - }, - "git_push_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8.git\"" - }, - "html_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8\"" - }, - "created_at": { - "type": "string", - "example": "\"2020-07-09T00:18:06Z\"" - }, - "updated_at": { - "type": "string", - "example": "\"2020-07-09T00:18:06Z\"" - }, - "description": { - "type": "string", - "example": "\"description\"", - "nullable": true - }, - "comments": { "type": "integer", "example": 1 }, - "comments_url": { + "node_id": { "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/comments\"" + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" } - } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "truncated": { + "type": "boolean" } - ] + } }, "examples": { "default": { @@ -23092,641 +22654,203 @@ "content": { "application/json": { "schema": { - "title": "Gist Full", - "description": "Gist Full", - "allOf": [ - { - "title": "Gist Simple", - "description": "Gist Simple", + "title": "Gist Simple", + "description": "Gist Simple", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "id": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "git_pull_url": { + "type": "string" + }, + "git_push_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "files": { "type": "object", - "properties": { - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string" - }, - "git_push_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "files": { - "type": "object", - "additionalProperties": { - "nullable": true, - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "user": { - "type": "string", - "nullable": true - }, - "comments_url": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } + "additionalProperties": { + "nullable": true, + "type": "object", + "properties": { + "filename": { + "type": "string" }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "truncated": { - "type": "boolean" + "type": { + "type": "string" + }, + "language": { + "type": "string" + }, + "raw_url": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "truncated": { + "type": "boolean" + }, + "content": { + "type": "string" + } } } }, - { + "public": { + "type": "boolean" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "user": { + "type": "string", + "nullable": true + }, + "comments_url": { + "type": "string" + }, + "owner": { + "title": "Simple User", + "description": "Simple User", "type": "object", "properties": { - "forks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "user": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - } - }, - "url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - } - } - } - }, - "history": { - "type": "array", - "items": { - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "version": { - "type": "string" - }, - "user": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - }, - "nullable": true - }, - "change_status": { - "type": "object", - "properties": { - "deletions": { - "type": "integer" - }, - "additions": { - "type": "integer" - }, - "total": { - "type": "integer" - } - } - }, - "committed_at": { - "type": "string" - } - } - } - }, - "fork_of": { - "nullable": true, - "allOf": [ - { - "title": "Gist Simple", - "description": "Gist Simple", - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string" - }, - "git_push_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "files": { - "type": "object", - "additionalProperties": { - "nullable": true, - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "user": { - "type": "string", - "nullable": true - }, - "comments_url": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "truncated": { - "type": "boolean" - } - } - } - ] - }, - "url": { + "login": { "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/cb5b95fe0f15ada6d34a421007ba2e4a34e2771e\"" - }, - "forks_url": { - "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/forks\"" - }, - "commits_url": { - "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/commits\"" + "example": "octocat" }, "id": { - "type": "string", - "example": "\"d8de7663c84491ba9eeb9ca1fd20ced8\"" - }, - "node_id": { - "type": "string", - "example": "\"MDQ6R2lzdGQ4ZGU3NjYzYzg0NDkxYmE5ZWViOWNhMWZkMjBjZWQ4\"" - }, - "git_pull_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8.git\"" - }, - "git_push_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8.git\"" - }, - "html_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8\"" - }, - "created_at": { - "type": "string", - "example": "\"2020-07-09T00:18:06Z\"" - }, - "updated_at": { - "type": "string", - "example": "\"2020-07-09T00:18:06Z\"" - }, - "description": { - "type": "string", - "example": "\"description\"", - "nullable": true - }, - "comments": { "type": "integer", "example": 1 }, - "comments_url": { + "node_id": { "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/comments\"" + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" } - } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "truncated": { + "type": "boolean" } - ] + } }, "examples": { "default": { @@ -23900,641 +23024,203 @@ "content": { "application/json": { "schema": { - "title": "Gist Full", - "description": "Gist Full", - "allOf": [ - { - "title": "Gist Simple", - "description": "Gist Simple", + "title": "Gist Simple", + "description": "Gist Simple", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "id": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "git_pull_url": { + "type": "string" + }, + "git_push_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "files": { "type": "object", - "properties": { - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string" - }, - "git_push_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "files": { - "type": "object", - "additionalProperties": { - "nullable": true, - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "user": { - "type": "string", - "nullable": true - }, - "comments_url": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } + "additionalProperties": { + "nullable": true, + "type": "object", + "properties": { + "filename": { + "type": "string" }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "truncated": { - "type": "boolean" + "type": { + "type": "string" + }, + "language": { + "type": "string" + }, + "raw_url": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "truncated": { + "type": "boolean" + }, + "content": { + "type": "string" + } } } }, - { + "public": { + "type": "boolean" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "user": { + "type": "string", + "nullable": true + }, + "comments_url": { + "type": "string" + }, + "owner": { + "title": "Simple User", + "description": "Simple User", "type": "object", "properties": { - "forks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "user": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - } - }, - "url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - } - } - } - }, - "history": { - "type": "array", - "items": { - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "version": { - "type": "string" - }, - "user": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - }, - "nullable": true - }, - "change_status": { - "type": "object", - "properties": { - "deletions": { - "type": "integer" - }, - "additions": { - "type": "integer" - }, - "total": { - "type": "integer" - } - } - }, - "committed_at": { - "type": "string" - } - } - } - }, - "fork_of": { - "nullable": true, - "allOf": [ - { - "title": "Gist Simple", - "description": "Gist Simple", - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string" - }, - "git_push_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "files": { - "type": "object", - "additionalProperties": { - "nullable": true, - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "user": { - "type": "string", - "nullable": true - }, - "comments_url": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "truncated": { - "type": "boolean" - } - } - } - ] - }, - "url": { + "login": { "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/cb5b95fe0f15ada6d34a421007ba2e4a34e2771e\"" - }, - "forks_url": { - "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/forks\"" - }, - "commits_url": { - "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/commits\"" + "example": "octocat" }, "id": { - "type": "string", - "example": "\"d8de7663c84491ba9eeb9ca1fd20ced8\"" - }, - "node_id": { - "type": "string", - "example": "\"MDQ6R2lzdGQ4ZGU3NjYzYzg0NDkxYmE5ZWViOWNhMWZkMjBjZWQ4\"" - }, - "git_pull_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8.git\"" - }, - "git_push_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8.git\"" - }, - "html_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8\"" - }, - "created_at": { - "type": "string", - "example": "\"2020-07-09T00:18:06Z\"" - }, - "updated_at": { - "type": "string", - "example": "\"2020-07-09T00:18:06Z\"" - }, - "description": { - "type": "string", - "example": "\"description\"", - "nullable": true - }, - "comments": { "type": "integer", "example": 1 }, - "comments_url": { + "node_id": { "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/comments\"" + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" } - } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "truncated": { + "type": "boolean" } - ] + } }, "examples": { "default": { @@ -26410,651 +25096,253 @@ "schema": { "type": "array", "items": { - "title": "Gist Full", - "description": "Gist Full", - "allOf": [ - { - "title": "Gist Simple", - "description": "Gist Simple", + "title": "Gist Simple", + "description": "Gist Simple", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "id": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "git_pull_url": { + "type": "string" + }, + "git_push_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "files": { "type": "object", - "properties": { - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string" - }, - "git_push_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "files": { - "type": "object", - "additionalProperties": { - "nullable": true, - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "user": { - "type": "string", - "nullable": true - }, - "comments_url": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } + "additionalProperties": { + "nullable": true, + "type": "object", + "properties": { + "filename": { + "type": "string" }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "truncated": { - "type": "boolean" + "type": { + "type": "string" + }, + "language": { + "type": "string" + }, + "raw_url": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "truncated": { + "type": "boolean" + }, + "content": { + "type": "string" + } } } }, - { + "public": { + "type": "boolean" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "user": { + "type": "string", + "nullable": true + }, + "comments_url": { + "type": "string" + }, + "owner": { + "title": "Simple User", + "description": "Simple User", "type": "object", "properties": { - "forks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "user": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - } - }, - "url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - } - } - } - }, - "history": { - "type": "array", - "items": { - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "version": { - "type": "string" - }, - "user": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - }, - "nullable": true - }, - "change_status": { - "type": "object", - "properties": { - "deletions": { - "type": "integer" - }, - "additions": { - "type": "integer" - }, - "total": { - "type": "integer" - } - } - }, - "committed_at": { - "type": "string" - } - } - } - }, - "fork_of": { - "nullable": true, - "allOf": [ - { - "title": "Gist Simple", - "description": "Gist Simple", - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string" - }, - "git_push_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "files": { - "type": "object", - "additionalProperties": { - "nullable": true, - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "user": { - "type": "string", - "nullable": true - }, - "comments_url": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "truncated": { - "type": "boolean" - } - } - } - ] - }, - "url": { + "login": { "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/cb5b95fe0f15ada6d34a421007ba2e4a34e2771e\"" - }, - "forks_url": { - "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/forks\"" - }, - "commits_url": { - "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/commits\"" + "example": "octocat" }, "id": { - "type": "string", - "example": "\"d8de7663c84491ba9eeb9ca1fd20ced8\"" - }, - "node_id": { - "type": "string", - "example": "\"MDQ6R2lzdGQ4ZGU3NjYzYzg0NDkxYmE5ZWViOWNhMWZkMjBjZWQ4\"" - }, - "git_pull_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8.git\"" - }, - "git_push_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8.git\"" - }, - "html_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8\"" - }, - "created_at": { - "type": "string", - "example": "\"2020-07-09T00:18:06Z\"" - }, - "updated_at": { - "type": "string", - "example": "\"2020-07-09T00:18:06Z\"" - }, - "description": { - "type": "string", - "example": "\"description\"", - "nullable": true - }, - "comments": { "type": "integer", "example": 1 }, - "comments_url": { + "node_id": { "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/comments\"" + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" } - } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "truncated": { + "type": "boolean" } - ] + } } }, "examples": { "default": { "value": [ { - "url": "https://api.github.com/gists/dee9c42e4998ce2ea439", - "id": "dee9c42e4998ce2ea439", - "created_at": "2011-04-14T16:00:49Z", - "updated_at": "2011-04-14T16:00:49Z" + "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", + "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks", + "commits_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/commits", + "id": "aa5a315d61ae9438b18d", + "node_id": "MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk", + "git_pull_url": "https://gist.github.com/aa5a315d61ae9438b18d.git", + "git_push_url": "https://gist.github.com/aa5a315d61ae9438b18d.git", + "html_url": "https://gist.github.com/aa5a315d61ae9438b18d", + "files": { + "hello_world.rb": { + "filename": "hello_world.rb", + "type": "application/x-ruby", + "language": "Ruby", + "raw_url": "https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb", + "size": 167 + } + }, + "public": true, + "created_at": "2010-04-14T02:15:15Z", + "updated_at": "2011-06-20T11:34:15Z", + "description": "Hello World Examples", + "comments": 1, + "user": null, + "comments_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/comments/", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } } ] } @@ -27956,641 +26244,203 @@ "content": { "application/json": { "schema": { - "title": "Gist Full", - "description": "Gist Full", - "allOf": [ - { - "title": "Gist Simple", - "description": "Gist Simple", + "title": "Gist Simple", + "description": "Gist Simple", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "id": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "git_pull_url": { + "type": "string" + }, + "git_push_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "files": { "type": "object", - "properties": { - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string" - }, - "git_push_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "files": { - "type": "object", - "additionalProperties": { - "nullable": true, - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "user": { - "type": "string", - "nullable": true - }, - "comments_url": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } + "additionalProperties": { + "nullable": true, + "type": "object", + "properties": { + "filename": { + "type": "string" }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "truncated": { - "type": "boolean" + "type": { + "type": "string" + }, + "language": { + "type": "string" + }, + "raw_url": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "truncated": { + "type": "boolean" + }, + "content": { + "type": "string" + } } } }, - { + "public": { + "type": "boolean" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "user": { + "type": "string", + "nullable": true + }, + "comments_url": { + "type": "string" + }, + "owner": { + "title": "Simple User", + "description": "Simple User", "type": "object", "properties": { - "forks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "user": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - } - }, - "url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - } - } - } - }, - "history": { - "type": "array", - "items": { - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "version": { - "type": "string" - }, - "user": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - }, - "nullable": true - }, - "change_status": { - "type": "object", - "properties": { - "deletions": { - "type": "integer" - }, - "additions": { - "type": "integer" - }, - "total": { - "type": "integer" - } - } - }, - "committed_at": { - "type": "string" - } - } - } - }, - "fork_of": { - "nullable": true, - "allOf": [ - { - "title": "Gist Simple", - "description": "Gist Simple", - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string" - }, - "git_push_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "files": { - "type": "object", - "additionalProperties": { - "nullable": true, - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "user": { - "type": "string", - "nullable": true - }, - "comments_url": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "truncated": { - "type": "boolean" - } - } - } - ] - }, - "url": { + "login": { "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/cb5b95fe0f15ada6d34a421007ba2e4a34e2771e\"" - }, - "forks_url": { - "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/forks\"" - }, - "commits_url": { - "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/commits\"" + "example": "octocat" }, "id": { - "type": "string", - "example": "\"d8de7663c84491ba9eeb9ca1fd20ced8\"" - }, - "node_id": { - "type": "string", - "example": "\"MDQ6R2lzdGQ4ZGU3NjYzYzg0NDkxYmE5ZWViOWNhMWZkMjBjZWQ4\"" - }, - "git_pull_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8.git\"" - }, - "git_push_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8.git\"" - }, - "html_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8\"" - }, - "created_at": { - "type": "string", - "example": "\"2020-07-09T00:18:06Z\"" - }, - "updated_at": { - "type": "string", - "example": "\"2020-07-09T00:18:06Z\"" - }, - "description": { - "type": "string", - "example": "\"description\"", - "nullable": true - }, - "comments": { "type": "integer", "example": 1 }, - "comments_url": { + "node_id": { "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/comments\"" + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" } - } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "truncated": { + "type": "boolean" } - ] + } }, "examples": { "default": { @@ -90112,7 +87962,7 @@ }, "put": { "summary": "Add a repository collaborator", - "description": "This 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.18/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\nFor more information the permission levels, see \"[Repository permission levels for an organization](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#http-verbs).\"\n\nThe invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [repository invitations API endpoints](https://docs.github.com/enterprise-server@2.18/rest/reference/repos#invitations).\n\n**Rate limits**\n\nTo prevent abuse, you are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.", + "description": "This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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.18/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\nFor more information the permission levels, see \"[Repository permission levels for an organization](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#http-verbs).\"\n\nThe invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [repository invitations API endpoints](https://docs.github.com/enterprise-server@2.18/rest/reference/repos#invitations).\n\n**Rate limits**\n\nTo prevent abuse, you are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.", "tags": [ "repos" ], @@ -95873,7 +93723,7 @@ }, "post": { "summary": "Create a commit comment", - "description": "Create a comment for a commit using its `:commit_sha`.\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.18/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", + "description": "Create a comment for a commit using its `:commit_sha`.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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.18/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", "tags": [ "repos" ], @@ -131289,7 +129139,7 @@ }, "post": { "summary": "Create an issue", - "description": "Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://help.github.com/articles/disabling-issues/), the API returns a `410 Gone` status.\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.18/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)\" for details.", + "description": "Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://help.github.com/articles/disabling-issues/), the API returns a `410 Gone` status.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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.18/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)\" for details.", "tags": [ "issues" ], @@ -153283,7 +151133,7 @@ }, "post": { "summary": "Create an issue comment", - "description": "This 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.18/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)\" for details.", + "description": "This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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.18/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)\" for details.", "tags": [ "issues" ], @@ -181840,7 +179690,7 @@ }, "post": { "summary": "Create a review comment for a pull request (alternative)", - "description": "Creates 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.18/rest/reference/issues#create-an-issue-comment).\"\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.18/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" for details.", + "description": "Creates 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.18/rest/reference/issues#create-an-issue-comment).\"\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://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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.18/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" for details.", "operationId": "pulls/create-review-comment-alternative", "tags": [ "pulls" @@ -182130,7 +179980,7 @@ "/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies": { "post": { "summary": "Create a reply for a review comment", - "description": "Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported.\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.18/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", + "description": "Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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.18/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", "tags": [ "pulls" ], @@ -188621,7 +186471,7 @@ }, "post": { "summary": "Create a review for a pull request", - "description": "This 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.18/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\nPull request reviews created in the `PENDING` state do not include the `submitted_at` property in the response.\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API v3 offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/enterprise-server@2.18/rest/reference/pulls#get-a-pull-request) endpoint.\n\nThe `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.", + "description": "This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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.18/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\nPull request reviews created in the `PENDING` state do not include the `submitted_at` property in the response.\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API v3 offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/enterprise-server@2.18/rest/reference/pulls#get-a-pull-request) endpoint.\n\nThe `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.", "tags": [ "pulls" ], @@ -192502,7 +190352,7 @@ }, "post": { "summary": "Create a release", - "description": "Users with push access to the repository can create a release.\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.18/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", + "description": "Users with push access to the repository can create a release.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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.18/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", "tags": [ "repos" ], @@ -214683,7 +212533,7 @@ }, "post": { "summary": "Create a discussion", - "description": "Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\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.18/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" for details.", + "description": "Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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.18/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" for details.", "operationId": "teams/create-discussion", "tags": [ "teams" @@ -216363,7 +214213,7 @@ }, "post": { "summary": "Create a discussion comment", - "description": "Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\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.18/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" for details.", + "description": "Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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.18/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" for details.", "operationId": "teams/create-discussion-comment", "tags": [ "teams" diff --git a/lib/rest/static/dereferenced/ghes-2.19.deref.json b/lib/rest/static/dereferenced/ghes-2.19.deref.json index 76b173de06..cb80201fd1 100644 --- a/lib/rest/static/dereferenced/ghes-2.19.deref.json +++ b/lib/rest/static/dereferenced/ghes-2.19.deref.json @@ -21224,641 +21224,203 @@ "content": { "application/json": { "schema": { - "title": "Gist Full", - "description": "Gist Full", - "allOf": [ - { - "title": "Gist Simple", - "description": "Gist Simple", + "title": "Gist Simple", + "description": "Gist Simple", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "id": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "git_pull_url": { + "type": "string" + }, + "git_push_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "files": { "type": "object", - "properties": { - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string" - }, - "git_push_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "files": { - "type": "object", - "additionalProperties": { - "nullable": true, - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "user": { - "type": "string", - "nullable": true - }, - "comments_url": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } + "additionalProperties": { + "nullable": true, + "type": "object", + "properties": { + "filename": { + "type": "string" }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "truncated": { - "type": "boolean" + "type": { + "type": "string" + }, + "language": { + "type": "string" + }, + "raw_url": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "truncated": { + "type": "boolean" + }, + "content": { + "type": "string" + } } } }, - { + "public": { + "type": "boolean" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "user": { + "type": "string", + "nullable": true + }, + "comments_url": { + "type": "string" + }, + "owner": { + "title": "Simple User", + "description": "Simple User", "type": "object", "properties": { - "forks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "user": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - } - }, - "url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - } - } - } - }, - "history": { - "type": "array", - "items": { - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "version": { - "type": "string" - }, - "user": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - }, - "nullable": true - }, - "change_status": { - "type": "object", - "properties": { - "deletions": { - "type": "integer" - }, - "additions": { - "type": "integer" - }, - "total": { - "type": "integer" - } - } - }, - "committed_at": { - "type": "string" - } - } - } - }, - "fork_of": { - "nullable": true, - "allOf": [ - { - "title": "Gist Simple", - "description": "Gist Simple", - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string" - }, - "git_push_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "files": { - "type": "object", - "additionalProperties": { - "nullable": true, - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "user": { - "type": "string", - "nullable": true - }, - "comments_url": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "truncated": { - "type": "boolean" - } - } - } - ] - }, - "url": { + "login": { "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/cb5b95fe0f15ada6d34a421007ba2e4a34e2771e\"" - }, - "forks_url": { - "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/forks\"" - }, - "commits_url": { - "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/commits\"" + "example": "octocat" }, "id": { - "type": "string", - "example": "\"d8de7663c84491ba9eeb9ca1fd20ced8\"" - }, - "node_id": { - "type": "string", - "example": "\"MDQ6R2lzdGQ4ZGU3NjYzYzg0NDkxYmE5ZWViOWNhMWZkMjBjZWQ4\"" - }, - "git_pull_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8.git\"" - }, - "git_push_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8.git\"" - }, - "html_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8\"" - }, - "created_at": { - "type": "string", - "example": "\"2020-07-09T00:18:06Z\"" - }, - "updated_at": { - "type": "string", - "example": "\"2020-07-09T00:18:06Z\"" - }, - "description": { - "type": "string", - "example": "\"description\"", - "nullable": true - }, - "comments": { "type": "integer", "example": 1 }, - "comments_url": { + "node_id": { "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/comments\"" + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" } - } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "truncated": { + "type": "boolean" } - ] + } }, "examples": { "default": { @@ -23122,641 +22684,203 @@ "content": { "application/json": { "schema": { - "title": "Gist Full", - "description": "Gist Full", - "allOf": [ - { - "title": "Gist Simple", - "description": "Gist Simple", + "title": "Gist Simple", + "description": "Gist Simple", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "id": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "git_pull_url": { + "type": "string" + }, + "git_push_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "files": { "type": "object", - "properties": { - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string" - }, - "git_push_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "files": { - "type": "object", - "additionalProperties": { - "nullable": true, - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "user": { - "type": "string", - "nullable": true - }, - "comments_url": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } + "additionalProperties": { + "nullable": true, + "type": "object", + "properties": { + "filename": { + "type": "string" }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "truncated": { - "type": "boolean" + "type": { + "type": "string" + }, + "language": { + "type": "string" + }, + "raw_url": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "truncated": { + "type": "boolean" + }, + "content": { + "type": "string" + } } } }, - { + "public": { + "type": "boolean" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "user": { + "type": "string", + "nullable": true + }, + "comments_url": { + "type": "string" + }, + "owner": { + "title": "Simple User", + "description": "Simple User", "type": "object", "properties": { - "forks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "user": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - } - }, - "url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - } - } - } - }, - "history": { - "type": "array", - "items": { - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "version": { - "type": "string" - }, - "user": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - }, - "nullable": true - }, - "change_status": { - "type": "object", - "properties": { - "deletions": { - "type": "integer" - }, - "additions": { - "type": "integer" - }, - "total": { - "type": "integer" - } - } - }, - "committed_at": { - "type": "string" - } - } - } - }, - "fork_of": { - "nullable": true, - "allOf": [ - { - "title": "Gist Simple", - "description": "Gist Simple", - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string" - }, - "git_push_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "files": { - "type": "object", - "additionalProperties": { - "nullable": true, - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "user": { - "type": "string", - "nullable": true - }, - "comments_url": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "truncated": { - "type": "boolean" - } - } - } - ] - }, - "url": { + "login": { "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/cb5b95fe0f15ada6d34a421007ba2e4a34e2771e\"" - }, - "forks_url": { - "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/forks\"" - }, - "commits_url": { - "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/commits\"" + "example": "octocat" }, "id": { - "type": "string", - "example": "\"d8de7663c84491ba9eeb9ca1fd20ced8\"" - }, - "node_id": { - "type": "string", - "example": "\"MDQ6R2lzdGQ4ZGU3NjYzYzg0NDkxYmE5ZWViOWNhMWZkMjBjZWQ4\"" - }, - "git_pull_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8.git\"" - }, - "git_push_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8.git\"" - }, - "html_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8\"" - }, - "created_at": { - "type": "string", - "example": "\"2020-07-09T00:18:06Z\"" - }, - "updated_at": { - "type": "string", - "example": "\"2020-07-09T00:18:06Z\"" - }, - "description": { - "type": "string", - "example": "\"description\"", - "nullable": true - }, - "comments": { "type": "integer", "example": 1 }, - "comments_url": { + "node_id": { "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/comments\"" + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" } - } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "truncated": { + "type": "boolean" } - ] + } }, "examples": { "default": { @@ -23930,641 +23054,203 @@ "content": { "application/json": { "schema": { - "title": "Gist Full", - "description": "Gist Full", - "allOf": [ - { - "title": "Gist Simple", - "description": "Gist Simple", + "title": "Gist Simple", + "description": "Gist Simple", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "id": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "git_pull_url": { + "type": "string" + }, + "git_push_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "files": { "type": "object", - "properties": { - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string" - }, - "git_push_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "files": { - "type": "object", - "additionalProperties": { - "nullable": true, - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "user": { - "type": "string", - "nullable": true - }, - "comments_url": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } + "additionalProperties": { + "nullable": true, + "type": "object", + "properties": { + "filename": { + "type": "string" }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "truncated": { - "type": "boolean" + "type": { + "type": "string" + }, + "language": { + "type": "string" + }, + "raw_url": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "truncated": { + "type": "boolean" + }, + "content": { + "type": "string" + } } } }, - { + "public": { + "type": "boolean" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "user": { + "type": "string", + "nullable": true + }, + "comments_url": { + "type": "string" + }, + "owner": { + "title": "Simple User", + "description": "Simple User", "type": "object", "properties": { - "forks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "user": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - } - }, - "url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - } - } - } - }, - "history": { - "type": "array", - "items": { - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "version": { - "type": "string" - }, - "user": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - }, - "nullable": true - }, - "change_status": { - "type": "object", - "properties": { - "deletions": { - "type": "integer" - }, - "additions": { - "type": "integer" - }, - "total": { - "type": "integer" - } - } - }, - "committed_at": { - "type": "string" - } - } - } - }, - "fork_of": { - "nullable": true, - "allOf": [ - { - "title": "Gist Simple", - "description": "Gist Simple", - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string" - }, - "git_push_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "files": { - "type": "object", - "additionalProperties": { - "nullable": true, - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "user": { - "type": "string", - "nullable": true - }, - "comments_url": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "truncated": { - "type": "boolean" - } - } - } - ] - }, - "url": { + "login": { "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/cb5b95fe0f15ada6d34a421007ba2e4a34e2771e\"" - }, - "forks_url": { - "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/forks\"" - }, - "commits_url": { - "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/commits\"" + "example": "octocat" }, "id": { - "type": "string", - "example": "\"d8de7663c84491ba9eeb9ca1fd20ced8\"" - }, - "node_id": { - "type": "string", - "example": "\"MDQ6R2lzdGQ4ZGU3NjYzYzg0NDkxYmE5ZWViOWNhMWZkMjBjZWQ4\"" - }, - "git_pull_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8.git\"" - }, - "git_push_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8.git\"" - }, - "html_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8\"" - }, - "created_at": { - "type": "string", - "example": "\"2020-07-09T00:18:06Z\"" - }, - "updated_at": { - "type": "string", - "example": "\"2020-07-09T00:18:06Z\"" - }, - "description": { - "type": "string", - "example": "\"description\"", - "nullable": true - }, - "comments": { "type": "integer", "example": 1 }, - "comments_url": { + "node_id": { "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/comments\"" + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" } - } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "truncated": { + "type": "boolean" } - ] + } }, "examples": { "default": { @@ -26440,651 +25126,253 @@ "schema": { "type": "array", "items": { - "title": "Gist Full", - "description": "Gist Full", - "allOf": [ - { - "title": "Gist Simple", - "description": "Gist Simple", + "title": "Gist Simple", + "description": "Gist Simple", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "id": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "git_pull_url": { + "type": "string" + }, + "git_push_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "files": { "type": "object", - "properties": { - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string" - }, - "git_push_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "files": { - "type": "object", - "additionalProperties": { - "nullable": true, - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "user": { - "type": "string", - "nullable": true - }, - "comments_url": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } + "additionalProperties": { + "nullable": true, + "type": "object", + "properties": { + "filename": { + "type": "string" }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "truncated": { - "type": "boolean" + "type": { + "type": "string" + }, + "language": { + "type": "string" + }, + "raw_url": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "truncated": { + "type": "boolean" + }, + "content": { + "type": "string" + } } } }, - { + "public": { + "type": "boolean" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "user": { + "type": "string", + "nullable": true + }, + "comments_url": { + "type": "string" + }, + "owner": { + "title": "Simple User", + "description": "Simple User", "type": "object", "properties": { - "forks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "user": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - } - }, - "url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - } - } - } - }, - "history": { - "type": "array", - "items": { - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "version": { - "type": "string" - }, - "user": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - }, - "nullable": true - }, - "change_status": { - "type": "object", - "properties": { - "deletions": { - "type": "integer" - }, - "additions": { - "type": "integer" - }, - "total": { - "type": "integer" - } - } - }, - "committed_at": { - "type": "string" - } - } - } - }, - "fork_of": { - "nullable": true, - "allOf": [ - { - "title": "Gist Simple", - "description": "Gist Simple", - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string" - }, - "git_push_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "files": { - "type": "object", - "additionalProperties": { - "nullable": true, - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "user": { - "type": "string", - "nullable": true - }, - "comments_url": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "truncated": { - "type": "boolean" - } - } - } - ] - }, - "url": { + "login": { "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/cb5b95fe0f15ada6d34a421007ba2e4a34e2771e\"" - }, - "forks_url": { - "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/forks\"" - }, - "commits_url": { - "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/commits\"" + "example": "octocat" }, "id": { - "type": "string", - "example": "\"d8de7663c84491ba9eeb9ca1fd20ced8\"" - }, - "node_id": { - "type": "string", - "example": "\"MDQ6R2lzdGQ4ZGU3NjYzYzg0NDkxYmE5ZWViOWNhMWZkMjBjZWQ4\"" - }, - "git_pull_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8.git\"" - }, - "git_push_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8.git\"" - }, - "html_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8\"" - }, - "created_at": { - "type": "string", - "example": "\"2020-07-09T00:18:06Z\"" - }, - "updated_at": { - "type": "string", - "example": "\"2020-07-09T00:18:06Z\"" - }, - "description": { - "type": "string", - "example": "\"description\"", - "nullable": true - }, - "comments": { "type": "integer", "example": 1 }, - "comments_url": { + "node_id": { "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/comments\"" + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" } - } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "truncated": { + "type": "boolean" } - ] + } } }, "examples": { "default": { "value": [ { - "url": "https://api.github.com/gists/dee9c42e4998ce2ea439", - "id": "dee9c42e4998ce2ea439", - "created_at": "2011-04-14T16:00:49Z", - "updated_at": "2011-04-14T16:00:49Z" + "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", + "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks", + "commits_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/commits", + "id": "aa5a315d61ae9438b18d", + "node_id": "MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk", + "git_pull_url": "https://gist.github.com/aa5a315d61ae9438b18d.git", + "git_push_url": "https://gist.github.com/aa5a315d61ae9438b18d.git", + "html_url": "https://gist.github.com/aa5a315d61ae9438b18d", + "files": { + "hello_world.rb": { + "filename": "hello_world.rb", + "type": "application/x-ruby", + "language": "Ruby", + "raw_url": "https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb", + "size": 167 + } + }, + "public": true, + "created_at": "2010-04-14T02:15:15Z", + "updated_at": "2011-06-20T11:34:15Z", + "description": "Hello World Examples", + "comments": 1, + "user": null, + "comments_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/comments/", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } } ] } @@ -27986,641 +26274,203 @@ "content": { "application/json": { "schema": { - "title": "Gist Full", - "description": "Gist Full", - "allOf": [ - { - "title": "Gist Simple", - "description": "Gist Simple", + "title": "Gist Simple", + "description": "Gist Simple", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "id": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "git_pull_url": { + "type": "string" + }, + "git_push_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "files": { "type": "object", - "properties": { - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string" - }, - "git_push_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "files": { - "type": "object", - "additionalProperties": { - "nullable": true, - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "user": { - "type": "string", - "nullable": true - }, - "comments_url": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } + "additionalProperties": { + "nullable": true, + "type": "object", + "properties": { + "filename": { + "type": "string" }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "truncated": { - "type": "boolean" + "type": { + "type": "string" + }, + "language": { + "type": "string" + }, + "raw_url": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "truncated": { + "type": "boolean" + }, + "content": { + "type": "string" + } } } }, - { + "public": { + "type": "boolean" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "user": { + "type": "string", + "nullable": true + }, + "comments_url": { + "type": "string" + }, + "owner": { + "title": "Simple User", + "description": "Simple User", "type": "object", "properties": { - "forks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "user": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - } - }, - "url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - } - } - } - }, - "history": { - "type": "array", - "items": { - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "version": { - "type": "string" - }, - "user": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - }, - "nullable": true - }, - "change_status": { - "type": "object", - "properties": { - "deletions": { - "type": "integer" - }, - "additions": { - "type": "integer" - }, - "total": { - "type": "integer" - } - } - }, - "committed_at": { - "type": "string" - } - } - } - }, - "fork_of": { - "nullable": true, - "allOf": [ - { - "title": "Gist Simple", - "description": "Gist Simple", - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string" - }, - "git_push_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "files": { - "type": "object", - "additionalProperties": { - "nullable": true, - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "user": { - "type": "string", - "nullable": true - }, - "comments_url": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "truncated": { - "type": "boolean" - } - } - } - ] - }, - "url": { + "login": { "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/cb5b95fe0f15ada6d34a421007ba2e4a34e2771e\"" - }, - "forks_url": { - "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/forks\"" - }, - "commits_url": { - "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/commits\"" + "example": "octocat" }, "id": { - "type": "string", - "example": "\"d8de7663c84491ba9eeb9ca1fd20ced8\"" - }, - "node_id": { - "type": "string", - "example": "\"MDQ6R2lzdGQ4ZGU3NjYzYzg0NDkxYmE5ZWViOWNhMWZkMjBjZWQ4\"" - }, - "git_pull_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8.git\"" - }, - "git_push_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8.git\"" - }, - "html_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8\"" - }, - "created_at": { - "type": "string", - "example": "\"2020-07-09T00:18:06Z\"" - }, - "updated_at": { - "type": "string", - "example": "\"2020-07-09T00:18:06Z\"" - }, - "description": { - "type": "string", - "example": "\"description\"", - "nullable": true - }, - "comments": { "type": "integer", "example": 1 }, - "comments_url": { + "node_id": { "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/comments\"" + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" } - } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "truncated": { + "type": "boolean" } - ] + } }, "examples": { "default": { @@ -93070,7 +90920,7 @@ }, "put": { "summary": "Add a repository collaborator", - "description": "This 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.19/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.19/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\nFor more information the permission levels, see \"[Repository permission levels for an organization](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@2.19/rest/overview/resources-in-the-rest-api#http-verbs).\"\n\nThe invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [repository invitations API endpoints](https://docs.github.com/enterprise-server@2.19/rest/reference/repos#invitations).\n\n**Rate limits**\n\nTo prevent abuse, you are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.", + "description": "This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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.19/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.19/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\nFor more information the permission levels, see \"[Repository permission levels for an organization](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@2.19/rest/overview/resources-in-the-rest-api#http-verbs).\"\n\nThe invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [repository invitations API endpoints](https://docs.github.com/enterprise-server@2.19/rest/reference/repos#invitations).\n\n**Rate limits**\n\nTo prevent abuse, you are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.", "tags": [ "repos" ], @@ -98831,7 +96681,7 @@ }, "post": { "summary": "Create a commit comment", - "description": "Create a comment for a commit using its `:commit_sha`.\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.19/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.19/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", + "description": "Create a comment for a commit using its `:commit_sha`.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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.19/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.19/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", "tags": [ "repos" ], @@ -134485,7 +132335,7 @@ }, "post": { "summary": "Create an issue", - "description": "Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://help.github.com/articles/disabling-issues/), the API returns a `410 Gone` status.\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.19/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.19/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)\" for details.", + "description": "Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://help.github.com/articles/disabling-issues/), the API returns a `410 Gone` status.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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.19/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.19/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)\" for details.", "tags": [ "issues" ], @@ -156534,7 +154384,7 @@ }, "post": { "summary": "Create an issue comment", - "description": "This 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.19/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.19/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)\" for details.", + "description": "This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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.19/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.19/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)\" for details.", "tags": [ "issues" ], @@ -185233,7 +183083,7 @@ }, "post": { "summary": "Create a review comment for a pull request (alternative)", - "description": "Creates 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.19/rest/reference/issues#create-an-issue-comment).\"\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.19/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" for details.", + "description": "Creates 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.19/rest/reference/issues#create-an-issue-comment).\"\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://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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.19/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" for details.", "operationId": "pulls/create-review-comment-alternative", "tags": [ "pulls" @@ -185523,7 +183373,7 @@ "/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies": { "post": { "summary": "Create a reply for a review comment", - "description": "Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported.\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.19/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.19/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", + "description": "Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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.19/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.19/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", "tags": [ "pulls" ], @@ -192014,7 +189864,7 @@ }, "post": { "summary": "Create a review for a pull request", - "description": "This 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.19/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.19/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\nPull request reviews created in the `PENDING` state do not include the `submitted_at` property in the response.\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API v3 offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/enterprise-server@2.19/rest/reference/pulls#get-a-pull-request) endpoint.\n\nThe `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.", + "description": "This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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.19/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.19/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\nPull request reviews created in the `PENDING` state do not include the `submitted_at` property in the response.\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API v3 offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/enterprise-server@2.19/rest/reference/pulls#get-a-pull-request) endpoint.\n\nThe `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.", "tags": [ "pulls" ], @@ -195895,7 +193745,7 @@ }, "post": { "summary": "Create a release", - "description": "Users with push access to the repository can create a release.\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.19/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.19/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", + "description": "Users with push access to the repository can create a release.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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.19/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.19/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", "tags": [ "repos" ], @@ -218069,7 +215919,7 @@ }, "post": { "summary": "Create a discussion", - "description": "Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.19/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\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.19/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" for details.", + "description": "Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.19/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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.19/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" for details.", "operationId": "teams/create-discussion", "tags": [ "teams" @@ -219671,7 +217521,7 @@ }, "post": { "summary": "Create a discussion comment", - "description": "Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.19/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\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.19/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" for details.", + "description": "Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.19/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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.19/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" for details.", "operationId": "teams/create-discussion-comment", "tags": [ "teams" diff --git a/lib/rest/static/dereferenced/ghes-2.20.deref.json b/lib/rest/static/dereferenced/ghes-2.20.deref.json index c5a183abf7..127e2d57a4 100644 --- a/lib/rest/static/dereferenced/ghes-2.20.deref.json +++ b/lib/rest/static/dereferenced/ghes-2.20.deref.json @@ -24140,641 +24140,203 @@ "content": { "application/json": { "schema": { - "title": "Gist Full", - "description": "Gist Full", - "allOf": [ - { - "title": "Gist Simple", - "description": "Gist Simple", + "title": "Gist Simple", + "description": "Gist Simple", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "id": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "git_pull_url": { + "type": "string" + }, + "git_push_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "files": { "type": "object", - "properties": { - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string" - }, - "git_push_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "files": { - "type": "object", - "additionalProperties": { - "nullable": true, - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "user": { - "type": "string", - "nullable": true - }, - "comments_url": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } + "additionalProperties": { + "nullable": true, + "type": "object", + "properties": { + "filename": { + "type": "string" }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "truncated": { - "type": "boolean" + "type": { + "type": "string" + }, + "language": { + "type": "string" + }, + "raw_url": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "truncated": { + "type": "boolean" + }, + "content": { + "type": "string" + } } } }, - { + "public": { + "type": "boolean" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "user": { + "type": "string", + "nullable": true + }, + "comments_url": { + "type": "string" + }, + "owner": { + "title": "Simple User", + "description": "Simple User", "type": "object", "properties": { - "forks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "user": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - } - }, - "url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - } - } - } - }, - "history": { - "type": "array", - "items": { - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "version": { - "type": "string" - }, - "user": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - }, - "nullable": true - }, - "change_status": { - "type": "object", - "properties": { - "deletions": { - "type": "integer" - }, - "additions": { - "type": "integer" - }, - "total": { - "type": "integer" - } - } - }, - "committed_at": { - "type": "string" - } - } - } - }, - "fork_of": { - "nullable": true, - "allOf": [ - { - "title": "Gist Simple", - "description": "Gist Simple", - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string" - }, - "git_push_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "files": { - "type": "object", - "additionalProperties": { - "nullable": true, - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "user": { - "type": "string", - "nullable": true - }, - "comments_url": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "truncated": { - "type": "boolean" - } - } - } - ] - }, - "url": { + "login": { "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/cb5b95fe0f15ada6d34a421007ba2e4a34e2771e\"" - }, - "forks_url": { - "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/forks\"" - }, - "commits_url": { - "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/commits\"" + "example": "octocat" }, "id": { - "type": "string", - "example": "\"d8de7663c84491ba9eeb9ca1fd20ced8\"" - }, - "node_id": { - "type": "string", - "example": "\"MDQ6R2lzdGQ4ZGU3NjYzYzg0NDkxYmE5ZWViOWNhMWZkMjBjZWQ4\"" - }, - "git_pull_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8.git\"" - }, - "git_push_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8.git\"" - }, - "html_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8\"" - }, - "created_at": { - "type": "string", - "example": "\"2020-07-09T00:18:06Z\"" - }, - "updated_at": { - "type": "string", - "example": "\"2020-07-09T00:18:06Z\"" - }, - "description": { - "type": "string", - "example": "\"description\"", - "nullable": true - }, - "comments": { "type": "integer", "example": 1 }, - "comments_url": { + "node_id": { "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/comments\"" + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" } - } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "truncated": { + "type": "boolean" } - ] + } }, "examples": { "default": { @@ -26038,641 +25600,203 @@ "content": { "application/json": { "schema": { - "title": "Gist Full", - "description": "Gist Full", - "allOf": [ - { - "title": "Gist Simple", - "description": "Gist Simple", + "title": "Gist Simple", + "description": "Gist Simple", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "id": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "git_pull_url": { + "type": "string" + }, + "git_push_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "files": { "type": "object", - "properties": { - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string" - }, - "git_push_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "files": { - "type": "object", - "additionalProperties": { - "nullable": true, - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "user": { - "type": "string", - "nullable": true - }, - "comments_url": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } + "additionalProperties": { + "nullable": true, + "type": "object", + "properties": { + "filename": { + "type": "string" }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "truncated": { - "type": "boolean" + "type": { + "type": "string" + }, + "language": { + "type": "string" + }, + "raw_url": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "truncated": { + "type": "boolean" + }, + "content": { + "type": "string" + } } } }, - { + "public": { + "type": "boolean" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "user": { + "type": "string", + "nullable": true + }, + "comments_url": { + "type": "string" + }, + "owner": { + "title": "Simple User", + "description": "Simple User", "type": "object", "properties": { - "forks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "user": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - } - }, - "url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - } - } - } - }, - "history": { - "type": "array", - "items": { - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "version": { - "type": "string" - }, - "user": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - }, - "nullable": true - }, - "change_status": { - "type": "object", - "properties": { - "deletions": { - "type": "integer" - }, - "additions": { - "type": "integer" - }, - "total": { - "type": "integer" - } - } - }, - "committed_at": { - "type": "string" - } - } - } - }, - "fork_of": { - "nullable": true, - "allOf": [ - { - "title": "Gist Simple", - "description": "Gist Simple", - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string" - }, - "git_push_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "files": { - "type": "object", - "additionalProperties": { - "nullable": true, - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "user": { - "type": "string", - "nullable": true - }, - "comments_url": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "truncated": { - "type": "boolean" - } - } - } - ] - }, - "url": { + "login": { "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/cb5b95fe0f15ada6d34a421007ba2e4a34e2771e\"" - }, - "forks_url": { - "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/forks\"" - }, - "commits_url": { - "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/commits\"" + "example": "octocat" }, "id": { - "type": "string", - "example": "\"d8de7663c84491ba9eeb9ca1fd20ced8\"" - }, - "node_id": { - "type": "string", - "example": "\"MDQ6R2lzdGQ4ZGU3NjYzYzg0NDkxYmE5ZWViOWNhMWZkMjBjZWQ4\"" - }, - "git_pull_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8.git\"" - }, - "git_push_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8.git\"" - }, - "html_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8\"" - }, - "created_at": { - "type": "string", - "example": "\"2020-07-09T00:18:06Z\"" - }, - "updated_at": { - "type": "string", - "example": "\"2020-07-09T00:18:06Z\"" - }, - "description": { - "type": "string", - "example": "\"description\"", - "nullable": true - }, - "comments": { "type": "integer", "example": 1 }, - "comments_url": { + "node_id": { "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/comments\"" + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" } - } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "truncated": { + "type": "boolean" } - ] + } }, "examples": { "default": { @@ -26846,641 +25970,203 @@ "content": { "application/json": { "schema": { - "title": "Gist Full", - "description": "Gist Full", - "allOf": [ - { - "title": "Gist Simple", - "description": "Gist Simple", + "title": "Gist Simple", + "description": "Gist Simple", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "id": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "git_pull_url": { + "type": "string" + }, + "git_push_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "files": { "type": "object", - "properties": { - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string" - }, - "git_push_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "files": { - "type": "object", - "additionalProperties": { - "nullable": true, - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "user": { - "type": "string", - "nullable": true - }, - "comments_url": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } + "additionalProperties": { + "nullable": true, + "type": "object", + "properties": { + "filename": { + "type": "string" }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "truncated": { - "type": "boolean" + "type": { + "type": "string" + }, + "language": { + "type": "string" + }, + "raw_url": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "truncated": { + "type": "boolean" + }, + "content": { + "type": "string" + } } } }, - { + "public": { + "type": "boolean" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "user": { + "type": "string", + "nullable": true + }, + "comments_url": { + "type": "string" + }, + "owner": { + "title": "Simple User", + "description": "Simple User", "type": "object", "properties": { - "forks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "user": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - } - }, - "url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - } - } - } - }, - "history": { - "type": "array", - "items": { - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "version": { - "type": "string" - }, - "user": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - }, - "nullable": true - }, - "change_status": { - "type": "object", - "properties": { - "deletions": { - "type": "integer" - }, - "additions": { - "type": "integer" - }, - "total": { - "type": "integer" - } - } - }, - "committed_at": { - "type": "string" - } - } - } - }, - "fork_of": { - "nullable": true, - "allOf": [ - { - "title": "Gist Simple", - "description": "Gist Simple", - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string" - }, - "git_push_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "files": { - "type": "object", - "additionalProperties": { - "nullable": true, - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "user": { - "type": "string", - "nullable": true - }, - "comments_url": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "truncated": { - "type": "boolean" - } - } - } - ] - }, - "url": { + "login": { "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/cb5b95fe0f15ada6d34a421007ba2e4a34e2771e\"" - }, - "forks_url": { - "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/forks\"" - }, - "commits_url": { - "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/commits\"" + "example": "octocat" }, "id": { - "type": "string", - "example": "\"d8de7663c84491ba9eeb9ca1fd20ced8\"" - }, - "node_id": { - "type": "string", - "example": "\"MDQ6R2lzdGQ4ZGU3NjYzYzg0NDkxYmE5ZWViOWNhMWZkMjBjZWQ4\"" - }, - "git_pull_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8.git\"" - }, - "git_push_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8.git\"" - }, - "html_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8\"" - }, - "created_at": { - "type": "string", - "example": "\"2020-07-09T00:18:06Z\"" - }, - "updated_at": { - "type": "string", - "example": "\"2020-07-09T00:18:06Z\"" - }, - "description": { - "type": "string", - "example": "\"description\"", - "nullable": true - }, - "comments": { "type": "integer", "example": 1 }, - "comments_url": { + "node_id": { "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/comments\"" + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" } - } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "truncated": { + "type": "boolean" } - ] + } }, "examples": { "default": { @@ -29356,651 +28042,253 @@ "schema": { "type": "array", "items": { - "title": "Gist Full", - "description": "Gist Full", - "allOf": [ - { - "title": "Gist Simple", - "description": "Gist Simple", + "title": "Gist Simple", + "description": "Gist Simple", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "id": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "git_pull_url": { + "type": "string" + }, + "git_push_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "files": { "type": "object", - "properties": { - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string" - }, - "git_push_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "files": { - "type": "object", - "additionalProperties": { - "nullable": true, - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "user": { - "type": "string", - "nullable": true - }, - "comments_url": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } + "additionalProperties": { + "nullable": true, + "type": "object", + "properties": { + "filename": { + "type": "string" }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "truncated": { - "type": "boolean" + "type": { + "type": "string" + }, + "language": { + "type": "string" + }, + "raw_url": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "truncated": { + "type": "boolean" + }, + "content": { + "type": "string" + } } } }, - { + "public": { + "type": "boolean" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "user": { + "type": "string", + "nullable": true + }, + "comments_url": { + "type": "string" + }, + "owner": { + "title": "Simple User", + "description": "Simple User", "type": "object", "properties": { - "forks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "user": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - } - }, - "url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - } - } - } - }, - "history": { - "type": "array", - "items": { - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "version": { - "type": "string" - }, - "user": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - }, - "nullable": true - }, - "change_status": { - "type": "object", - "properties": { - "deletions": { - "type": "integer" - }, - "additions": { - "type": "integer" - }, - "total": { - "type": "integer" - } - } - }, - "committed_at": { - "type": "string" - } - } - } - }, - "fork_of": { - "nullable": true, - "allOf": [ - { - "title": "Gist Simple", - "description": "Gist Simple", - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string" - }, - "git_push_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "files": { - "type": "object", - "additionalProperties": { - "nullable": true, - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "user": { - "type": "string", - "nullable": true - }, - "comments_url": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "truncated": { - "type": "boolean" - } - } - } - ] - }, - "url": { + "login": { "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/cb5b95fe0f15ada6d34a421007ba2e4a34e2771e\"" - }, - "forks_url": { - "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/forks\"" - }, - "commits_url": { - "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/commits\"" + "example": "octocat" }, "id": { - "type": "string", - "example": "\"d8de7663c84491ba9eeb9ca1fd20ced8\"" - }, - "node_id": { - "type": "string", - "example": "\"MDQ6R2lzdGQ4ZGU3NjYzYzg0NDkxYmE5ZWViOWNhMWZkMjBjZWQ4\"" - }, - "git_pull_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8.git\"" - }, - "git_push_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8.git\"" - }, - "html_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8\"" - }, - "created_at": { - "type": "string", - "example": "\"2020-07-09T00:18:06Z\"" - }, - "updated_at": { - "type": "string", - "example": "\"2020-07-09T00:18:06Z\"" - }, - "description": { - "type": "string", - "example": "\"description\"", - "nullable": true - }, - "comments": { "type": "integer", "example": 1 }, - "comments_url": { + "node_id": { "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/comments\"" + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" } - } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "truncated": { + "type": "boolean" } - ] + } } }, "examples": { "default": { "value": [ { - "url": "https://api.github.com/gists/dee9c42e4998ce2ea439", - "id": "dee9c42e4998ce2ea439", - "created_at": "2011-04-14T16:00:49Z", - "updated_at": "2011-04-14T16:00:49Z" + "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", + "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks", + "commits_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/commits", + "id": "aa5a315d61ae9438b18d", + "node_id": "MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk", + "git_pull_url": "https://gist.github.com/aa5a315d61ae9438b18d.git", + "git_push_url": "https://gist.github.com/aa5a315d61ae9438b18d.git", + "html_url": "https://gist.github.com/aa5a315d61ae9438b18d", + "files": { + "hello_world.rb": { + "filename": "hello_world.rb", + "type": "application/x-ruby", + "language": "Ruby", + "raw_url": "https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb", + "size": 167 + } + }, + "public": true, + "created_at": "2010-04-14T02:15:15Z", + "updated_at": "2011-06-20T11:34:15Z", + "description": "Hello World Examples", + "comments": 1, + "user": null, + "comments_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/comments/", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } } ] } @@ -30902,641 +29190,203 @@ "content": { "application/json": { "schema": { - "title": "Gist Full", - "description": "Gist Full", - "allOf": [ - { - "title": "Gist Simple", - "description": "Gist Simple", + "title": "Gist Simple", + "description": "Gist Simple", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "id": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "git_pull_url": { + "type": "string" + }, + "git_push_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "files": { "type": "object", - "properties": { - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string" - }, - "git_push_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "files": { - "type": "object", - "additionalProperties": { - "nullable": true, - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "user": { - "type": "string", - "nullable": true - }, - "comments_url": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } + "additionalProperties": { + "nullable": true, + "type": "object", + "properties": { + "filename": { + "type": "string" }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "truncated": { - "type": "boolean" + "type": { + "type": "string" + }, + "language": { + "type": "string" + }, + "raw_url": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "truncated": { + "type": "boolean" + }, + "content": { + "type": "string" + } } } }, - { + "public": { + "type": "boolean" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "user": { + "type": "string", + "nullable": true + }, + "comments_url": { + "type": "string" + }, + "owner": { + "title": "Simple User", + "description": "Simple User", "type": "object", "properties": { - "forks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "user": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - } - }, - "url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - } - } - } - }, - "history": { - "type": "array", - "items": { - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "version": { - "type": "string" - }, - "user": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - }, - "nullable": true - }, - "change_status": { - "type": "object", - "properties": { - "deletions": { - "type": "integer" - }, - "additions": { - "type": "integer" - }, - "total": { - "type": "integer" - } - } - }, - "committed_at": { - "type": "string" - } - } - } - }, - "fork_of": { - "nullable": true, - "allOf": [ - { - "title": "Gist Simple", - "description": "Gist Simple", - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string" - }, - "git_push_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "files": { - "type": "object", - "additionalProperties": { - "nullable": true, - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "user": { - "type": "string", - "nullable": true - }, - "comments_url": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "truncated": { - "type": "boolean" - } - } - } - ] - }, - "url": { + "login": { "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/cb5b95fe0f15ada6d34a421007ba2e4a34e2771e\"" - }, - "forks_url": { - "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/forks\"" - }, - "commits_url": { - "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/commits\"" + "example": "octocat" }, "id": { - "type": "string", - "example": "\"d8de7663c84491ba9eeb9ca1fd20ced8\"" - }, - "node_id": { - "type": "string", - "example": "\"MDQ6R2lzdGQ4ZGU3NjYzYzg0NDkxYmE5ZWViOWNhMWZkMjBjZWQ4\"" - }, - "git_pull_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8.git\"" - }, - "git_push_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8.git\"" - }, - "html_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8\"" - }, - "created_at": { - "type": "string", - "example": "\"2020-07-09T00:18:06Z\"" - }, - "updated_at": { - "type": "string", - "example": "\"2020-07-09T00:18:06Z\"" - }, - "description": { - "type": "string", - "example": "\"description\"", - "nullable": true - }, - "comments": { "type": "integer", "example": 1 }, - "comments_url": { + "node_id": { "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/comments\"" + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" } - } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "truncated": { + "type": "boolean" } - ] + } }, "examples": { "default": { @@ -95204,7 +93054,7 @@ }, "put": { "summary": "Add a repository collaborator", - "description": "This 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\nFor more information the permission levels, see \"[Repository permission levels for an organization](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@2.20/rest/overview/resources-in-the-rest-api#http-verbs).\"\n\nThe invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [repository invitations API endpoints](https://docs.github.com/enterprise-server@2.20/rest/reference/repos#invitations).\n\n**Rate limits**\n\nTo prevent abuse, you are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.", + "description": "This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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\nFor more information the permission levels, see \"[Repository permission levels for an organization](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@2.20/rest/overview/resources-in-the-rest-api#http-verbs).\"\n\nThe invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [repository invitations API endpoints](https://docs.github.com/enterprise-server@2.20/rest/reference/repos#invitations).\n\n**Rate limits**\n\nTo prevent abuse, you are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.", "tags": [ "repos" ], @@ -100976,7 +98826,7 @@ }, "post": { "summary": "Create a commit comment", - "description": "Create a comment for a commit using its `:commit_sha`.\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.", + "description": "Create a comment for a commit using its `:commit_sha`.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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": [ "repos" ], @@ -136730,7 +134580,7 @@ }, "post": { "summary": "Create an issue", - "description": "Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://help.github.com/articles/disabling-issues/), the API returns a `410 Gone` status.\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-abuse-rate-limits)\" for details.", + "description": "Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://help.github.com/articles/disabling-issues/), the API returns a `410 Gone` status.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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-abuse-rate-limits)\" for details.", "tags": [ "issues" ], @@ -158835,7 +156685,7 @@ }, "post": { "summary": "Create an issue comment", - "description": "This 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-abuse-rate-limits)\" for details.", + "description": "This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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-abuse-rate-limits)\" for details.", "tags": [ "issues" ], @@ -187751,7 +185601,7 @@ }, "post": { "summary": "Create a review comment for a pull request", - "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.", + "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://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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" ], @@ -188429,7 +186279,7 @@ "/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies": { "post": { "summary": "Create a reply for a review comment", - "description": "Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported.\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.", + "description": "Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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" ], @@ -194985,7 +192835,7 @@ }, "post": { "summary": "Create a review for a pull request", - "description": "This 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\nPull request reviews created in the `PENDING` state do not include the `submitted_at` property in the response.\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API v3 offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/enterprise-server@2.20/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/enterprise-server@2.20/rest/reference/pulls#get-a-pull-request) endpoint.\n\nThe `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.", + "description": "This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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\nPull request reviews created in the `PENDING` state do not include the `submitted_at` property in the response.\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API v3 offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/enterprise-server@2.20/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/enterprise-server@2.20/rest/reference/pulls#get-a-pull-request) endpoint.\n\nThe `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.", "tags": [ "pulls" ], @@ -198866,7 +196716,7 @@ }, "post": { "summary": "Create a release", - "description": "Users with push access to the repository can create a release.\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.", + "description": "Users with push access to the repository can create a release.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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": [ "repos" ], @@ -221108,7 +218958,7 @@ }, "post": { "summary": "Create a discussion", - "description": "Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.20/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\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)\" for details.", + "description": "Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.20/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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)\" for details.", "operationId": "teams/create-discussion", "tags": [ "teams" @@ -222710,7 +220560,7 @@ }, "post": { "summary": "Create a discussion comment", - "description": "Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.20/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\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)\" for details.", + "description": "Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.20/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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)\" for details.", "operationId": "teams/create-discussion-comment", "tags": [ "teams" diff --git a/lib/rest/static/dereferenced/ghes-2.21.deref.json b/lib/rest/static/dereferenced/ghes-2.21.deref.json index 6e6338401c..28443aa62c 100644 --- a/lib/rest/static/dereferenced/ghes-2.21.deref.json +++ b/lib/rest/static/dereferenced/ghes-2.21.deref.json @@ -24154,641 +24154,203 @@ "content": { "application/json": { "schema": { - "title": "Gist Full", - "description": "Gist Full", - "allOf": [ - { - "title": "Gist Simple", - "description": "Gist Simple", + "title": "Gist Simple", + "description": "Gist Simple", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "id": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "git_pull_url": { + "type": "string" + }, + "git_push_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "files": { "type": "object", - "properties": { - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string" - }, - "git_push_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "files": { - "type": "object", - "additionalProperties": { - "nullable": true, - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "user": { - "type": "string", - "nullable": true - }, - "comments_url": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } + "additionalProperties": { + "nullable": true, + "type": "object", + "properties": { + "filename": { + "type": "string" }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "truncated": { - "type": "boolean" + "type": { + "type": "string" + }, + "language": { + "type": "string" + }, + "raw_url": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "truncated": { + "type": "boolean" + }, + "content": { + "type": "string" + } } } }, - { + "public": { + "type": "boolean" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "user": { + "type": "string", + "nullable": true + }, + "comments_url": { + "type": "string" + }, + "owner": { + "title": "Simple User", + "description": "Simple User", "type": "object", "properties": { - "forks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "user": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - } - }, - "url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - } - } - } - }, - "history": { - "type": "array", - "items": { - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "version": { - "type": "string" - }, - "user": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - }, - "nullable": true - }, - "change_status": { - "type": "object", - "properties": { - "deletions": { - "type": "integer" - }, - "additions": { - "type": "integer" - }, - "total": { - "type": "integer" - } - } - }, - "committed_at": { - "type": "string" - } - } - } - }, - "fork_of": { - "nullable": true, - "allOf": [ - { - "title": "Gist Simple", - "description": "Gist Simple", - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string" - }, - "git_push_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "files": { - "type": "object", - "additionalProperties": { - "nullable": true, - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "user": { - "type": "string", - "nullable": true - }, - "comments_url": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "truncated": { - "type": "boolean" - } - } - } - ] - }, - "url": { + "login": { "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/cb5b95fe0f15ada6d34a421007ba2e4a34e2771e\"" - }, - "forks_url": { - "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/forks\"" - }, - "commits_url": { - "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/commits\"" + "example": "octocat" }, "id": { - "type": "string", - "example": "\"d8de7663c84491ba9eeb9ca1fd20ced8\"" - }, - "node_id": { - "type": "string", - "example": "\"MDQ6R2lzdGQ4ZGU3NjYzYzg0NDkxYmE5ZWViOWNhMWZkMjBjZWQ4\"" - }, - "git_pull_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8.git\"" - }, - "git_push_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8.git\"" - }, - "html_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8\"" - }, - "created_at": { - "type": "string", - "example": "\"2020-07-09T00:18:06Z\"" - }, - "updated_at": { - "type": "string", - "example": "\"2020-07-09T00:18:06Z\"" - }, - "description": { - "type": "string", - "example": "\"description\"", - "nullable": true - }, - "comments": { "type": "integer", "example": 1 }, - "comments_url": { + "node_id": { "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/comments\"" + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" } - } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "truncated": { + "type": "boolean" } - ] + } }, "examples": { "default": { @@ -26052,641 +25614,203 @@ "content": { "application/json": { "schema": { - "title": "Gist Full", - "description": "Gist Full", - "allOf": [ - { - "title": "Gist Simple", - "description": "Gist Simple", + "title": "Gist Simple", + "description": "Gist Simple", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "id": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "git_pull_url": { + "type": "string" + }, + "git_push_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "files": { "type": "object", - "properties": { - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string" - }, - "git_push_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "files": { - "type": "object", - "additionalProperties": { - "nullable": true, - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "user": { - "type": "string", - "nullable": true - }, - "comments_url": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } + "additionalProperties": { + "nullable": true, + "type": "object", + "properties": { + "filename": { + "type": "string" }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "truncated": { - "type": "boolean" + "type": { + "type": "string" + }, + "language": { + "type": "string" + }, + "raw_url": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "truncated": { + "type": "boolean" + }, + "content": { + "type": "string" + } } } }, - { + "public": { + "type": "boolean" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "user": { + "type": "string", + "nullable": true + }, + "comments_url": { + "type": "string" + }, + "owner": { + "title": "Simple User", + "description": "Simple User", "type": "object", "properties": { - "forks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "user": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - } - }, - "url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - } - } - } - }, - "history": { - "type": "array", - "items": { - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "version": { - "type": "string" - }, - "user": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - }, - "nullable": true - }, - "change_status": { - "type": "object", - "properties": { - "deletions": { - "type": "integer" - }, - "additions": { - "type": "integer" - }, - "total": { - "type": "integer" - } - } - }, - "committed_at": { - "type": "string" - } - } - } - }, - "fork_of": { - "nullable": true, - "allOf": [ - { - "title": "Gist Simple", - "description": "Gist Simple", - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string" - }, - "git_push_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "files": { - "type": "object", - "additionalProperties": { - "nullable": true, - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "user": { - "type": "string", - "nullable": true - }, - "comments_url": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "truncated": { - "type": "boolean" - } - } - } - ] - }, - "url": { + "login": { "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/cb5b95fe0f15ada6d34a421007ba2e4a34e2771e\"" - }, - "forks_url": { - "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/forks\"" - }, - "commits_url": { - "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/commits\"" + "example": "octocat" }, "id": { - "type": "string", - "example": "\"d8de7663c84491ba9eeb9ca1fd20ced8\"" - }, - "node_id": { - "type": "string", - "example": "\"MDQ6R2lzdGQ4ZGU3NjYzYzg0NDkxYmE5ZWViOWNhMWZkMjBjZWQ4\"" - }, - "git_pull_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8.git\"" - }, - "git_push_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8.git\"" - }, - "html_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8\"" - }, - "created_at": { - "type": "string", - "example": "\"2020-07-09T00:18:06Z\"" - }, - "updated_at": { - "type": "string", - "example": "\"2020-07-09T00:18:06Z\"" - }, - "description": { - "type": "string", - "example": "\"description\"", - "nullable": true - }, - "comments": { "type": "integer", "example": 1 }, - "comments_url": { + "node_id": { "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/comments\"" + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" } - } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "truncated": { + "type": "boolean" } - ] + } }, "examples": { "default": { @@ -26860,641 +25984,203 @@ "content": { "application/json": { "schema": { - "title": "Gist Full", - "description": "Gist Full", - "allOf": [ - { - "title": "Gist Simple", - "description": "Gist Simple", + "title": "Gist Simple", + "description": "Gist Simple", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "id": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "git_pull_url": { + "type": "string" + }, + "git_push_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "files": { "type": "object", - "properties": { - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string" - }, - "git_push_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "files": { - "type": "object", - "additionalProperties": { - "nullable": true, - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "user": { - "type": "string", - "nullable": true - }, - "comments_url": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } + "additionalProperties": { + "nullable": true, + "type": "object", + "properties": { + "filename": { + "type": "string" }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "truncated": { - "type": "boolean" + "type": { + "type": "string" + }, + "language": { + "type": "string" + }, + "raw_url": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "truncated": { + "type": "boolean" + }, + "content": { + "type": "string" + } } } }, - { + "public": { + "type": "boolean" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "user": { + "type": "string", + "nullable": true + }, + "comments_url": { + "type": "string" + }, + "owner": { + "title": "Simple User", + "description": "Simple User", "type": "object", "properties": { - "forks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "user": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - } - }, - "url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - } - } - } - }, - "history": { - "type": "array", - "items": { - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "version": { - "type": "string" - }, - "user": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - }, - "nullable": true - }, - "change_status": { - "type": "object", - "properties": { - "deletions": { - "type": "integer" - }, - "additions": { - "type": "integer" - }, - "total": { - "type": "integer" - } - } - }, - "committed_at": { - "type": "string" - } - } - } - }, - "fork_of": { - "nullable": true, - "allOf": [ - { - "title": "Gist Simple", - "description": "Gist Simple", - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string" - }, - "git_push_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "files": { - "type": "object", - "additionalProperties": { - "nullable": true, - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "user": { - "type": "string", - "nullable": true - }, - "comments_url": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "truncated": { - "type": "boolean" - } - } - } - ] - }, - "url": { + "login": { "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/cb5b95fe0f15ada6d34a421007ba2e4a34e2771e\"" - }, - "forks_url": { - "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/forks\"" - }, - "commits_url": { - "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/commits\"" + "example": "octocat" }, "id": { - "type": "string", - "example": "\"d8de7663c84491ba9eeb9ca1fd20ced8\"" - }, - "node_id": { - "type": "string", - "example": "\"MDQ6R2lzdGQ4ZGU3NjYzYzg0NDkxYmE5ZWViOWNhMWZkMjBjZWQ4\"" - }, - "git_pull_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8.git\"" - }, - "git_push_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8.git\"" - }, - "html_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8\"" - }, - "created_at": { - "type": "string", - "example": "\"2020-07-09T00:18:06Z\"" - }, - "updated_at": { - "type": "string", - "example": "\"2020-07-09T00:18:06Z\"" - }, - "description": { - "type": "string", - "example": "\"description\"", - "nullable": true - }, - "comments": { "type": "integer", "example": 1 }, - "comments_url": { + "node_id": { "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/comments\"" + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" } - } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "truncated": { + "type": "boolean" } - ] + } }, "examples": { "default": { @@ -29370,651 +28056,253 @@ "schema": { "type": "array", "items": { - "title": "Gist Full", - "description": "Gist Full", - "allOf": [ - { - "title": "Gist Simple", - "description": "Gist Simple", + "title": "Gist Simple", + "description": "Gist Simple", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "id": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "git_pull_url": { + "type": "string" + }, + "git_push_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "files": { "type": "object", - "properties": { - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string" - }, - "git_push_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "files": { - "type": "object", - "additionalProperties": { - "nullable": true, - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "user": { - "type": "string", - "nullable": true - }, - "comments_url": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } + "additionalProperties": { + "nullable": true, + "type": "object", + "properties": { + "filename": { + "type": "string" }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "truncated": { - "type": "boolean" + "type": { + "type": "string" + }, + "language": { + "type": "string" + }, + "raw_url": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "truncated": { + "type": "boolean" + }, + "content": { + "type": "string" + } } } }, - { + "public": { + "type": "boolean" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "user": { + "type": "string", + "nullable": true + }, + "comments_url": { + "type": "string" + }, + "owner": { + "title": "Simple User", + "description": "Simple User", "type": "object", "properties": { - "forks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "user": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - } - }, - "url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - } - } - } - }, - "history": { - "type": "array", - "items": { - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "version": { - "type": "string" - }, - "user": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - }, - "nullable": true - }, - "change_status": { - "type": "object", - "properties": { - "deletions": { - "type": "integer" - }, - "additions": { - "type": "integer" - }, - "total": { - "type": "integer" - } - } - }, - "committed_at": { - "type": "string" - } - } - } - }, - "fork_of": { - "nullable": true, - "allOf": [ - { - "title": "Gist Simple", - "description": "Gist Simple", - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string" - }, - "git_push_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "files": { - "type": "object", - "additionalProperties": { - "nullable": true, - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "user": { - "type": "string", - "nullable": true - }, - "comments_url": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "truncated": { - "type": "boolean" - } - } - } - ] - }, - "url": { + "login": { "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/cb5b95fe0f15ada6d34a421007ba2e4a34e2771e\"" - }, - "forks_url": { - "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/forks\"" - }, - "commits_url": { - "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/commits\"" + "example": "octocat" }, "id": { - "type": "string", - "example": "\"d8de7663c84491ba9eeb9ca1fd20ced8\"" - }, - "node_id": { - "type": "string", - "example": "\"MDQ6R2lzdGQ4ZGU3NjYzYzg0NDkxYmE5ZWViOWNhMWZkMjBjZWQ4\"" - }, - "git_pull_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8.git\"" - }, - "git_push_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8.git\"" - }, - "html_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8\"" - }, - "created_at": { - "type": "string", - "example": "\"2020-07-09T00:18:06Z\"" - }, - "updated_at": { - "type": "string", - "example": "\"2020-07-09T00:18:06Z\"" - }, - "description": { - "type": "string", - "example": "\"description\"", - "nullable": true - }, - "comments": { "type": "integer", "example": 1 }, - "comments_url": { + "node_id": { "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/comments\"" + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" } - } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "truncated": { + "type": "boolean" } - ] + } } }, "examples": { "default": { "value": [ { - "url": "https://api.github.com/gists/dee9c42e4998ce2ea439", - "id": "dee9c42e4998ce2ea439", - "created_at": "2011-04-14T16:00:49Z", - "updated_at": "2011-04-14T16:00:49Z" + "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", + "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks", + "commits_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/commits", + "id": "aa5a315d61ae9438b18d", + "node_id": "MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk", + "git_pull_url": "https://gist.github.com/aa5a315d61ae9438b18d.git", + "git_push_url": "https://gist.github.com/aa5a315d61ae9438b18d.git", + "html_url": "https://gist.github.com/aa5a315d61ae9438b18d", + "files": { + "hello_world.rb": { + "filename": "hello_world.rb", + "type": "application/x-ruby", + "language": "Ruby", + "raw_url": "https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb", + "size": 167 + } + }, + "public": true, + "created_at": "2010-04-14T02:15:15Z", + "updated_at": "2011-06-20T11:34:15Z", + "description": "Hello World Examples", + "comments": 1, + "user": null, + "comments_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/comments/", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } } ] } @@ -30916,641 +29204,203 @@ "content": { "application/json": { "schema": { - "title": "Gist Full", - "description": "Gist Full", - "allOf": [ - { - "title": "Gist Simple", - "description": "Gist Simple", + "title": "Gist Simple", + "description": "Gist Simple", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "id": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "git_pull_url": { + "type": "string" + }, + "git_push_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "files": { "type": "object", - "properties": { - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string" - }, - "git_push_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "files": { - "type": "object", - "additionalProperties": { - "nullable": true, - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "user": { - "type": "string", - "nullable": true - }, - "comments_url": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } + "additionalProperties": { + "nullable": true, + "type": "object", + "properties": { + "filename": { + "type": "string" }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "truncated": { - "type": "boolean" + "type": { + "type": "string" + }, + "language": { + "type": "string" + }, + "raw_url": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "truncated": { + "type": "boolean" + }, + "content": { + "type": "string" + } } } }, - { + "public": { + "type": "boolean" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "user": { + "type": "string", + "nullable": true + }, + "comments_url": { + "type": "string" + }, + "owner": { + "title": "Simple User", + "description": "Simple User", "type": "object", "properties": { - "forks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "user": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - } - }, - "url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - } - } - } - }, - "history": { - "type": "array", - "items": { - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "version": { - "type": "string" - }, - "user": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - }, - "nullable": true - }, - "change_status": { - "type": "object", - "properties": { - "deletions": { - "type": "integer" - }, - "additions": { - "type": "integer" - }, - "total": { - "type": "integer" - } - } - }, - "committed_at": { - "type": "string" - } - } - } - }, - "fork_of": { - "nullable": true, - "allOf": [ - { - "title": "Gist Simple", - "description": "Gist Simple", - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string" - }, - "git_push_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "files": { - "type": "object", - "additionalProperties": { - "nullable": true, - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "user": { - "type": "string", - "nullable": true - }, - "comments_url": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "truncated": { - "type": "boolean" - } - } - } - ] - }, - "url": { + "login": { "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/cb5b95fe0f15ada6d34a421007ba2e4a34e2771e\"" - }, - "forks_url": { - "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/forks\"" - }, - "commits_url": { - "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/commits\"" + "example": "octocat" }, "id": { - "type": "string", - "example": "\"d8de7663c84491ba9eeb9ca1fd20ced8\"" - }, - "node_id": { - "type": "string", - "example": "\"MDQ6R2lzdGQ4ZGU3NjYzYzg0NDkxYmE5ZWViOWNhMWZkMjBjZWQ4\"" - }, - "git_pull_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8.git\"" - }, - "git_push_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8.git\"" - }, - "html_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8\"" - }, - "created_at": { - "type": "string", - "example": "\"2020-07-09T00:18:06Z\"" - }, - "updated_at": { - "type": "string", - "example": "\"2020-07-09T00:18:06Z\"" - }, - "description": { - "type": "string", - "example": "\"description\"", - "nullable": true - }, - "comments": { "type": "integer", "example": 1 }, - "comments_url": { + "node_id": { "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/comments\"" + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" } - } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "truncated": { + "type": "boolean" } - ] + } }, "examples": { "default": { @@ -60888,7 +58738,7 @@ }, "post": { "summary": "Create a discussion", - "description": "Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.21/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\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**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`.", + "description": "Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.21/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`.", "tags": [ "teams" ], @@ -62539,7 +60389,7 @@ }, "post": { "summary": "Create a discussion comment", - "description": "Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.21/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\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**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.", + "description": "Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.21/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.", "tags": [ "teams" ], @@ -106073,7 +103923,7 @@ }, "put": { "summary": "Add a repository collaborator", - "description": "This 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\nFor more information the permission levels, see \"[Repository permission levels for an organization](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@2.21/rest/overview/resources-in-the-rest-api#http-verbs).\"\n\nThe invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [repository invitations API endpoints](https://docs.github.com/enterprise-server@2.21/rest/reference/repos#invitations).\n\n**Rate limits**\n\nTo prevent abuse, you are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.", + "description": "This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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\nFor more information the permission levels, see \"[Repository permission levels for an organization](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@2.21/rest/overview/resources-in-the-rest-api#http-verbs).\"\n\nThe invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [repository invitations API endpoints](https://docs.github.com/enterprise-server@2.21/rest/reference/repos#invitations).\n\n**Rate limits**\n\nTo prevent abuse, you are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.", "tags": [ "repos" ], @@ -111924,7 +109774,7 @@ }, "post": { "summary": "Create a commit comment", - "description": "Create a comment for a commit using its `:commit_sha`.\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.", + "description": "Create a comment for a commit using its `:commit_sha`.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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": [ "repos" ], @@ -147891,7 +145741,7 @@ }, "post": { "summary": "Create an issue", - "description": "Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://help.github.com/articles/disabling-issues/), the API returns a `410 Gone` status.\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-abuse-rate-limits)\" for details.", + "description": "Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://help.github.com/articles/disabling-issues/), the API returns a `410 Gone` status.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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-abuse-rate-limits)\" for details.", "tags": [ "issues" ], @@ -170126,7 +167976,7 @@ }, "post": { "summary": "Create an issue comment", - "description": "This 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-abuse-rate-limits)\" for details.", + "description": "This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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-abuse-rate-limits)\" for details.", "tags": [ "issues" ], @@ -199193,7 +197043,7 @@ }, "post": { "summary": "Create a review comment for a pull request", - "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.", + "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://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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" ], @@ -199871,7 +197721,7 @@ "/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies": { "post": { "summary": "Create a reply for a review comment", - "description": "Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported.\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.", + "description": "Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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" ], @@ -206447,7 +204297,7 @@ }, "post": { "summary": "Create a review for a pull request", - "description": "This 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\nPull request reviews created in the `PENDING` state do not include the `submitted_at` property in the response.\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API v3 offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/enterprise-server@2.21/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/enterprise-server@2.21/rest/reference/pulls#get-a-pull-request) endpoint.\n\nThe `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.", + "description": "This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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\nPull request reviews created in the `PENDING` state do not include the `submitted_at` property in the response.\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API v3 offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/enterprise-server@2.21/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/enterprise-server@2.21/rest/reference/pulls#get-a-pull-request) endpoint.\n\nThe `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.", "tags": [ "pulls" ], @@ -210328,7 +208178,7 @@ }, "post": { "summary": "Create a release", - "description": "Users with push access to the repository can create a release.\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.", + "description": "Users with push access to the repository can create a release.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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": [ "repos" ], @@ -232869,7 +230719,7 @@ }, "post": { "summary": "Create a discussion (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/enterprise-server@2.21/rest/reference/teams#create-a-discussion) endpoint.\n\nCreates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.21/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\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.", + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/enterprise-server@2.21/rest/reference/teams#create-a-discussion) endpoint.\n\nCreates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.21/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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": [ "teams" ], @@ -234490,7 +232340,7 @@ }, "post": { "summary": "Create a discussion comment (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/enterprise-server@2.21/rest/reference/teams#create-a-discussion-comment) endpoint.\n\nCreates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.21/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\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.", + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/enterprise-server@2.21/rest/reference/teams#create-a-discussion-comment) endpoint.\n\nCreates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.21/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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": [ "teams" ], diff --git a/lib/rest/static/dereferenced/ghes-2.22.deref.json b/lib/rest/static/dereferenced/ghes-2.22.deref.json index 60a5b5b2af..c964f4350b 100644 --- a/lib/rest/static/dereferenced/ghes-2.22.deref.json +++ b/lib/rest/static/dereferenced/ghes-2.22.deref.json @@ -27850,641 +27850,203 @@ "content": { "application/json": { "schema": { - "title": "Gist Full", - "description": "Gist Full", - "allOf": [ - { - "title": "Gist Simple", - "description": "Gist Simple", + "title": "Gist Simple", + "description": "Gist Simple", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "id": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "git_pull_url": { + "type": "string" + }, + "git_push_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "files": { "type": "object", - "properties": { - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string" - }, - "git_push_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "files": { - "type": "object", - "additionalProperties": { - "nullable": true, - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "user": { - "type": "string", - "nullable": true - }, - "comments_url": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } + "additionalProperties": { + "nullable": true, + "type": "object", + "properties": { + "filename": { + "type": "string" }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "truncated": { - "type": "boolean" + "type": { + "type": "string" + }, + "language": { + "type": "string" + }, + "raw_url": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "truncated": { + "type": "boolean" + }, + "content": { + "type": "string" + } } } }, - { + "public": { + "type": "boolean" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "user": { + "type": "string", + "nullable": true + }, + "comments_url": { + "type": "string" + }, + "owner": { + "title": "Simple User", + "description": "Simple User", "type": "object", "properties": { - "forks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "user": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - } - }, - "url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - } - } - } - }, - "history": { - "type": "array", - "items": { - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "version": { - "type": "string" - }, - "user": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - }, - "nullable": true - }, - "change_status": { - "type": "object", - "properties": { - "deletions": { - "type": "integer" - }, - "additions": { - "type": "integer" - }, - "total": { - "type": "integer" - } - } - }, - "committed_at": { - "type": "string" - } - } - } - }, - "fork_of": { - "nullable": true, - "allOf": [ - { - "title": "Gist Simple", - "description": "Gist Simple", - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string" - }, - "git_push_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "files": { - "type": "object", - "additionalProperties": { - "nullable": true, - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "user": { - "type": "string", - "nullable": true - }, - "comments_url": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "truncated": { - "type": "boolean" - } - } - } - ] - }, - "url": { + "login": { "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/cb5b95fe0f15ada6d34a421007ba2e4a34e2771e\"" - }, - "forks_url": { - "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/forks\"" - }, - "commits_url": { - "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/commits\"" + "example": "octocat" }, "id": { - "type": "string", - "example": "\"d8de7663c84491ba9eeb9ca1fd20ced8\"" - }, - "node_id": { - "type": "string", - "example": "\"MDQ6R2lzdGQ4ZGU3NjYzYzg0NDkxYmE5ZWViOWNhMWZkMjBjZWQ4\"" - }, - "git_pull_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8.git\"" - }, - "git_push_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8.git\"" - }, - "html_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8\"" - }, - "created_at": { - "type": "string", - "example": "\"2020-07-09T00:18:06Z\"" - }, - "updated_at": { - "type": "string", - "example": "\"2020-07-09T00:18:06Z\"" - }, - "description": { - "type": "string", - "example": "\"description\"", - "nullable": true - }, - "comments": { "type": "integer", "example": 1 }, - "comments_url": { + "node_id": { "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/comments\"" + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" } - } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "truncated": { + "type": "boolean" } - ] + } }, "examples": { "default": { @@ -29748,641 +29310,203 @@ "content": { "application/json": { "schema": { - "title": "Gist Full", - "description": "Gist Full", - "allOf": [ - { - "title": "Gist Simple", - "description": "Gist Simple", + "title": "Gist Simple", + "description": "Gist Simple", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "id": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "git_pull_url": { + "type": "string" + }, + "git_push_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "files": { "type": "object", - "properties": { - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string" - }, - "git_push_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "files": { - "type": "object", - "additionalProperties": { - "nullable": true, - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "user": { - "type": "string", - "nullable": true - }, - "comments_url": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } + "additionalProperties": { + "nullable": true, + "type": "object", + "properties": { + "filename": { + "type": "string" }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "truncated": { - "type": "boolean" + "type": { + "type": "string" + }, + "language": { + "type": "string" + }, + "raw_url": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "truncated": { + "type": "boolean" + }, + "content": { + "type": "string" + } } } }, - { + "public": { + "type": "boolean" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "user": { + "type": "string", + "nullable": true + }, + "comments_url": { + "type": "string" + }, + "owner": { + "title": "Simple User", + "description": "Simple User", "type": "object", "properties": { - "forks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "user": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - } - }, - "url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - } - } - } - }, - "history": { - "type": "array", - "items": { - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "version": { - "type": "string" - }, - "user": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - }, - "nullable": true - }, - "change_status": { - "type": "object", - "properties": { - "deletions": { - "type": "integer" - }, - "additions": { - "type": "integer" - }, - "total": { - "type": "integer" - } - } - }, - "committed_at": { - "type": "string" - } - } - } - }, - "fork_of": { - "nullable": true, - "allOf": [ - { - "title": "Gist Simple", - "description": "Gist Simple", - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string" - }, - "git_push_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "files": { - "type": "object", - "additionalProperties": { - "nullable": true, - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "user": { - "type": "string", - "nullable": true - }, - "comments_url": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "truncated": { - "type": "boolean" - } - } - } - ] - }, - "url": { + "login": { "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/cb5b95fe0f15ada6d34a421007ba2e4a34e2771e\"" - }, - "forks_url": { - "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/forks\"" - }, - "commits_url": { - "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/commits\"" + "example": "octocat" }, "id": { - "type": "string", - "example": "\"d8de7663c84491ba9eeb9ca1fd20ced8\"" - }, - "node_id": { - "type": "string", - "example": "\"MDQ6R2lzdGQ4ZGU3NjYzYzg0NDkxYmE5ZWViOWNhMWZkMjBjZWQ4\"" - }, - "git_pull_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8.git\"" - }, - "git_push_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8.git\"" - }, - "html_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8\"" - }, - "created_at": { - "type": "string", - "example": "\"2020-07-09T00:18:06Z\"" - }, - "updated_at": { - "type": "string", - "example": "\"2020-07-09T00:18:06Z\"" - }, - "description": { - "type": "string", - "example": "\"description\"", - "nullable": true - }, - "comments": { "type": "integer", "example": 1 }, - "comments_url": { + "node_id": { "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/comments\"" + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" } - } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "truncated": { + "type": "boolean" } - ] + } }, "examples": { "default": { @@ -30556,641 +29680,203 @@ "content": { "application/json": { "schema": { - "title": "Gist Full", - "description": "Gist Full", - "allOf": [ - { - "title": "Gist Simple", - "description": "Gist Simple", + "title": "Gist Simple", + "description": "Gist Simple", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "id": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "git_pull_url": { + "type": "string" + }, + "git_push_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "files": { "type": "object", - "properties": { - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string" - }, - "git_push_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "files": { - "type": "object", - "additionalProperties": { - "nullable": true, - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "user": { - "type": "string", - "nullable": true - }, - "comments_url": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } + "additionalProperties": { + "nullable": true, + "type": "object", + "properties": { + "filename": { + "type": "string" }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "truncated": { - "type": "boolean" + "type": { + "type": "string" + }, + "language": { + "type": "string" + }, + "raw_url": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "truncated": { + "type": "boolean" + }, + "content": { + "type": "string" + } } } }, - { + "public": { + "type": "boolean" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "user": { + "type": "string", + "nullable": true + }, + "comments_url": { + "type": "string" + }, + "owner": { + "title": "Simple User", + "description": "Simple User", "type": "object", "properties": { - "forks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "user": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - } - }, - "url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - } - } - } - }, - "history": { - "type": "array", - "items": { - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "version": { - "type": "string" - }, - "user": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - }, - "nullable": true - }, - "change_status": { - "type": "object", - "properties": { - "deletions": { - "type": "integer" - }, - "additions": { - "type": "integer" - }, - "total": { - "type": "integer" - } - } - }, - "committed_at": { - "type": "string" - } - } - } - }, - "fork_of": { - "nullable": true, - "allOf": [ - { - "title": "Gist Simple", - "description": "Gist Simple", - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string" - }, - "git_push_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "files": { - "type": "object", - "additionalProperties": { - "nullable": true, - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "user": { - "type": "string", - "nullable": true - }, - "comments_url": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "truncated": { - "type": "boolean" - } - } - } - ] - }, - "url": { + "login": { "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/cb5b95fe0f15ada6d34a421007ba2e4a34e2771e\"" - }, - "forks_url": { - "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/forks\"" - }, - "commits_url": { - "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/commits\"" + "example": "octocat" }, "id": { - "type": "string", - "example": "\"d8de7663c84491ba9eeb9ca1fd20ced8\"" - }, - "node_id": { - "type": "string", - "example": "\"MDQ6R2lzdGQ4ZGU3NjYzYzg0NDkxYmE5ZWViOWNhMWZkMjBjZWQ4\"" - }, - "git_pull_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8.git\"" - }, - "git_push_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8.git\"" - }, - "html_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8\"" - }, - "created_at": { - "type": "string", - "example": "\"2020-07-09T00:18:06Z\"" - }, - "updated_at": { - "type": "string", - "example": "\"2020-07-09T00:18:06Z\"" - }, - "description": { - "type": "string", - "example": "\"description\"", - "nullable": true - }, - "comments": { "type": "integer", "example": 1 }, - "comments_url": { + "node_id": { "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/comments\"" + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" } - } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "truncated": { + "type": "boolean" } - ] + } }, "examples": { "default": { @@ -33066,651 +31752,253 @@ "schema": { "type": "array", "items": { - "title": "Gist Full", - "description": "Gist Full", - "allOf": [ - { - "title": "Gist Simple", - "description": "Gist Simple", + "title": "Gist Simple", + "description": "Gist Simple", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "id": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "git_pull_url": { + "type": "string" + }, + "git_push_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "files": { "type": "object", - "properties": { - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string" - }, - "git_push_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "files": { - "type": "object", - "additionalProperties": { - "nullable": true, - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "user": { - "type": "string", - "nullable": true - }, - "comments_url": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } + "additionalProperties": { + "nullable": true, + "type": "object", + "properties": { + "filename": { + "type": "string" }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "truncated": { - "type": "boolean" + "type": { + "type": "string" + }, + "language": { + "type": "string" + }, + "raw_url": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "truncated": { + "type": "boolean" + }, + "content": { + "type": "string" + } } } }, - { + "public": { + "type": "boolean" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "user": { + "type": "string", + "nullable": true + }, + "comments_url": { + "type": "string" + }, + "owner": { + "title": "Simple User", + "description": "Simple User", "type": "object", "properties": { - "forks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "user": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - } - }, - "url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - } - } - } - }, - "history": { - "type": "array", - "items": { - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "version": { - "type": "string" - }, - "user": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - }, - "nullable": true - }, - "change_status": { - "type": "object", - "properties": { - "deletions": { - "type": "integer" - }, - "additions": { - "type": "integer" - }, - "total": { - "type": "integer" - } - } - }, - "committed_at": { - "type": "string" - } - } - } - }, - "fork_of": { - "nullable": true, - "allOf": [ - { - "title": "Gist Simple", - "description": "Gist Simple", - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string" - }, - "git_push_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "files": { - "type": "object", - "additionalProperties": { - "nullable": true, - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "user": { - "type": "string", - "nullable": true - }, - "comments_url": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "truncated": { - "type": "boolean" - } - } - } - ] - }, - "url": { + "login": { "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/cb5b95fe0f15ada6d34a421007ba2e4a34e2771e\"" - }, - "forks_url": { - "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/forks\"" - }, - "commits_url": { - "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/commits\"" + "example": "octocat" }, "id": { - "type": "string", - "example": "\"d8de7663c84491ba9eeb9ca1fd20ced8\"" - }, - "node_id": { - "type": "string", - "example": "\"MDQ6R2lzdGQ4ZGU3NjYzYzg0NDkxYmE5ZWViOWNhMWZkMjBjZWQ4\"" - }, - "git_pull_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8.git\"" - }, - "git_push_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8.git\"" - }, - "html_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8\"" - }, - "created_at": { - "type": "string", - "example": "\"2020-07-09T00:18:06Z\"" - }, - "updated_at": { - "type": "string", - "example": "\"2020-07-09T00:18:06Z\"" - }, - "description": { - "type": "string", - "example": "\"description\"", - "nullable": true - }, - "comments": { "type": "integer", "example": 1 }, - "comments_url": { + "node_id": { "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/comments\"" + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" } - } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "truncated": { + "type": "boolean" } - ] + } } }, "examples": { "default": { "value": [ { - "url": "https://api.github.com/gists/dee9c42e4998ce2ea439", - "id": "dee9c42e4998ce2ea439", - "created_at": "2011-04-14T16:00:49Z", - "updated_at": "2011-04-14T16:00:49Z" + "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", + "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks", + "commits_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/commits", + "id": "aa5a315d61ae9438b18d", + "node_id": "MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk", + "git_pull_url": "https://gist.github.com/aa5a315d61ae9438b18d.git", + "git_push_url": "https://gist.github.com/aa5a315d61ae9438b18d.git", + "html_url": "https://gist.github.com/aa5a315d61ae9438b18d", + "files": { + "hello_world.rb": { + "filename": "hello_world.rb", + "type": "application/x-ruby", + "language": "Ruby", + "raw_url": "https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb", + "size": 167 + } + }, + "public": true, + "created_at": "2010-04-14T02:15:15Z", + "updated_at": "2011-06-20T11:34:15Z", + "description": "Hello World Examples", + "comments": 1, + "user": null, + "comments_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/comments/", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } } ] } @@ -34612,641 +32900,203 @@ "content": { "application/json": { "schema": { - "title": "Gist Full", - "description": "Gist Full", - "allOf": [ - { - "title": "Gist Simple", - "description": "Gist Simple", + "title": "Gist Simple", + "description": "Gist Simple", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "id": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "git_pull_url": { + "type": "string" + }, + "git_push_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "files": { "type": "object", - "properties": { - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string" - }, - "git_push_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "files": { - "type": "object", - "additionalProperties": { - "nullable": true, - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "user": { - "type": "string", - "nullable": true - }, - "comments_url": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } + "additionalProperties": { + "nullable": true, + "type": "object", + "properties": { + "filename": { + "type": "string" }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "truncated": { - "type": "boolean" + "type": { + "type": "string" + }, + "language": { + "type": "string" + }, + "raw_url": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "truncated": { + "type": "boolean" + }, + "content": { + "type": "string" + } } } }, - { + "public": { + "type": "boolean" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "user": { + "type": "string", + "nullable": true + }, + "comments_url": { + "type": "string" + }, + "owner": { + "title": "Simple User", + "description": "Simple User", "type": "object", "properties": { - "forks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "user": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - } - }, - "url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - } - } - } - }, - "history": { - "type": "array", - "items": { - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "version": { - "type": "string" - }, - "user": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - }, - "nullable": true - }, - "change_status": { - "type": "object", - "properties": { - "deletions": { - "type": "integer" - }, - "additions": { - "type": "integer" - }, - "total": { - "type": "integer" - } - } - }, - "committed_at": { - "type": "string" - } - } - } - }, - "fork_of": { - "nullable": true, - "allOf": [ - { - "title": "Gist Simple", - "description": "Gist Simple", - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string" - }, - "git_push_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "files": { - "type": "object", - "additionalProperties": { - "nullable": true, - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "user": { - "type": "string", - "nullable": true - }, - "comments_url": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "truncated": { - "type": "boolean" - } - } - } - ] - }, - "url": { + "login": { "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/cb5b95fe0f15ada6d34a421007ba2e4a34e2771e\"" - }, - "forks_url": { - "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/forks\"" - }, - "commits_url": { - "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/commits\"" + "example": "octocat" }, "id": { - "type": "string", - "example": "\"d8de7663c84491ba9eeb9ca1fd20ced8\"" - }, - "node_id": { - "type": "string", - "example": "\"MDQ6R2lzdGQ4ZGU3NjYzYzg0NDkxYmE5ZWViOWNhMWZkMjBjZWQ4\"" - }, - "git_pull_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8.git\"" - }, - "git_push_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8.git\"" - }, - "html_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8\"" - }, - "created_at": { - "type": "string", - "example": "\"2020-07-09T00:18:06Z\"" - }, - "updated_at": { - "type": "string", - "example": "\"2020-07-09T00:18:06Z\"" - }, - "description": { - "type": "string", - "example": "\"description\"", - "nullable": true - }, - "comments": { "type": "integer", "example": 1 }, - "comments_url": { + "node_id": { "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/comments\"" + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" } - } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "truncated": { + "type": "boolean" } - ] + } }, "examples": { "default": { @@ -71752,7 +69602,7 @@ }, "post": { "summary": "Create a discussion", - "description": "Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\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**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`.", + "description": "Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`.", "tags": [ "teams" ], @@ -73403,7 +71253,7 @@ }, "post": { "summary": "Create a discussion comment", - "description": "Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\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**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.", + "description": "Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.", "tags": [ "teams" ], @@ -134318,7 +132168,7 @@ }, "put": { "summary": "Add a repository collaborator", - "description": "This 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\nFor more information the permission levels, see \"[Repository permission levels for an organization](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@2.22/rest/overview/resources-in-the-rest-api#http-verbs).\"\n\nThe invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [repository invitations API endpoints](https://docs.github.com/enterprise-server@2.22/rest/reference/repos#invitations).\n\n**Rate limits**\n\nTo prevent abuse, you are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.", + "description": "This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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\nFor more information the permission levels, see \"[Repository permission levels for an organization](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@2.22/rest/overview/resources-in-the-rest-api#http-verbs).\"\n\nThe invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [repository invitations API endpoints](https://docs.github.com/enterprise-server@2.22/rest/reference/repos#invitations).\n\n**Rate limits**\n\nTo prevent abuse, you are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.", "tags": [ "repos" ], @@ -140169,7 +138019,7 @@ }, "post": { "summary": "Create a commit comment", - "description": "Create a comment for a commit using its `:commit_sha`.\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.", + "description": "Create a comment for a commit using its `:commit_sha`.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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": [ "repos" ], @@ -176156,7 +174006,7 @@ }, "post": { "summary": "Create an issue", - "description": "Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://help.github.com/articles/disabling-issues/), the API returns a `410 Gone` status.\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-abuse-rate-limits)\" for details.", + "description": "Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://help.github.com/articles/disabling-issues/), the API returns a `410 Gone` status.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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-abuse-rate-limits)\" for details.", "tags": [ "issues" ], @@ -198376,7 +196226,7 @@ }, "post": { "summary": "Create an issue comment", - "description": "This 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-abuse-rate-limits)\" for details.", + "description": "This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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-abuse-rate-limits)\" for details.", "tags": [ "issues" ], @@ -214802,7 +212652,7 @@ }, "post": { "summary": "Create a pull request", - "description": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.\n\nYou can create a new pull request.\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.", + "description": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.\n\nYou can create a new pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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" ], @@ -227454,7 +225304,7 @@ }, "post": { "summary": "Create a review comment for a pull request", - "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.", + "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://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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" ], @@ -228132,7 +225982,7 @@ "/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies": { "post": { "summary": "Create a reply for a review comment", - "description": "Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported.\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.", + "description": "Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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" ], @@ -234712,7 +232562,7 @@ }, "post": { "summary": "Create a review for a pull request", - "description": "This 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\nPull request reviews created in the `PENDING` state do not include the `submitted_at` property in the response.\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API v3 offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/enterprise-server@2.22/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/enterprise-server@2.22/rest/reference/pulls#get-a-pull-request) endpoint.\n\nThe `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.", + "description": "This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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\nPull request reviews created in the `PENDING` state do not include the `submitted_at` property in the response.\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API v3 offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/enterprise-server@2.22/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/enterprise-server@2.22/rest/reference/pulls#get-a-pull-request) endpoint.\n\nThe `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.", "tags": [ "pulls" ], @@ -238593,7 +236443,7 @@ }, "post": { "summary": "Create a release", - "description": "Users with push access to the repository can create a release.\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.", + "description": "Users with push access to the repository can create a release.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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": [ "repos" ], @@ -261159,7 +259009,7 @@ }, "post": { "summary": "Create a discussion (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/enterprise-server@2.22/rest/reference/teams#create-a-discussion) endpoint.\n\nCreates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\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.", + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/enterprise-server@2.22/rest/reference/teams#create-a-discussion) endpoint.\n\nCreates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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": [ "teams" ], @@ -262780,7 +260630,7 @@ }, "post": { "summary": "Create a discussion comment (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/enterprise-server@2.22/rest/reference/teams#create-a-discussion-comment) endpoint.\n\nCreates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\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.", + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/enterprise-server@2.22/rest/reference/teams#create-a-discussion-comment) endpoint.\n\nCreates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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": [ "teams" ], diff --git a/lib/rest/static/dereferenced/ghes-3.0.deref.json b/lib/rest/static/dereferenced/ghes-3.0.deref.json index eabf66bfef..789115e9a0 100644 --- a/lib/rest/static/dereferenced/ghes-3.0.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.0.deref.json @@ -30271,641 +30271,203 @@ "content": { "application/json": { "schema": { - "title": "Gist Full", - "description": "Gist Full", - "allOf": [ - { - "title": "Gist Simple", - "description": "Gist Simple", + "title": "Gist Simple", + "description": "Gist Simple", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "id": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "git_pull_url": { + "type": "string" + }, + "git_push_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "files": { "type": "object", - "properties": { - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string" - }, - "git_push_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "files": { - "type": "object", - "additionalProperties": { - "nullable": true, - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "user": { - "type": "string", - "nullable": true - }, - "comments_url": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } + "additionalProperties": { + "nullable": true, + "type": "object", + "properties": { + "filename": { + "type": "string" }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "truncated": { - "type": "boolean" + "type": { + "type": "string" + }, + "language": { + "type": "string" + }, + "raw_url": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "truncated": { + "type": "boolean" + }, + "content": { + "type": "string" + } } } }, - { + "public": { + "type": "boolean" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "user": { + "type": "string", + "nullable": true + }, + "comments_url": { + "type": "string" + }, + "owner": { + "title": "Simple User", + "description": "Simple User", "type": "object", "properties": { - "forks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "user": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - } - }, - "url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - } - } - } - }, - "history": { - "type": "array", - "items": { - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "version": { - "type": "string" - }, - "user": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - }, - "nullable": true - }, - "change_status": { - "type": "object", - "properties": { - "deletions": { - "type": "integer" - }, - "additions": { - "type": "integer" - }, - "total": { - "type": "integer" - } - } - }, - "committed_at": { - "type": "string" - } - } - } - }, - "fork_of": { - "nullable": true, - "allOf": [ - { - "title": "Gist Simple", - "description": "Gist Simple", - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string" - }, - "git_push_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "files": { - "type": "object", - "additionalProperties": { - "nullable": true, - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "user": { - "type": "string", - "nullable": true - }, - "comments_url": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "truncated": { - "type": "boolean" - } - } - } - ] - }, - "url": { + "login": { "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/cb5b95fe0f15ada6d34a421007ba2e4a34e2771e\"" - }, - "forks_url": { - "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/forks\"" - }, - "commits_url": { - "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/commits\"" + "example": "octocat" }, "id": { - "type": "string", - "example": "\"d8de7663c84491ba9eeb9ca1fd20ced8\"" - }, - "node_id": { - "type": "string", - "example": "\"MDQ6R2lzdGQ4ZGU3NjYzYzg0NDkxYmE5ZWViOWNhMWZkMjBjZWQ4\"" - }, - "git_pull_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8.git\"" - }, - "git_push_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8.git\"" - }, - "html_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8\"" - }, - "created_at": { - "type": "string", - "example": "\"2020-07-09T00:18:06Z\"" - }, - "updated_at": { - "type": "string", - "example": "\"2020-07-09T00:18:06Z\"" - }, - "description": { - "type": "string", - "example": "\"description\"", - "nullable": true - }, - "comments": { "type": "integer", "example": 1 }, - "comments_url": { + "node_id": { "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/comments\"" + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" } - } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "truncated": { + "type": "boolean" } - ] + } }, "examples": { "default": { @@ -32169,641 +31731,203 @@ "content": { "application/json": { "schema": { - "title": "Gist Full", - "description": "Gist Full", - "allOf": [ - { - "title": "Gist Simple", - "description": "Gist Simple", + "title": "Gist Simple", + "description": "Gist Simple", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "id": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "git_pull_url": { + "type": "string" + }, + "git_push_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "files": { "type": "object", - "properties": { - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string" - }, - "git_push_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "files": { - "type": "object", - "additionalProperties": { - "nullable": true, - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "user": { - "type": "string", - "nullable": true - }, - "comments_url": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } + "additionalProperties": { + "nullable": true, + "type": "object", + "properties": { + "filename": { + "type": "string" }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "truncated": { - "type": "boolean" + "type": { + "type": "string" + }, + "language": { + "type": "string" + }, + "raw_url": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "truncated": { + "type": "boolean" + }, + "content": { + "type": "string" + } } } }, - { + "public": { + "type": "boolean" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "user": { + "type": "string", + "nullable": true + }, + "comments_url": { + "type": "string" + }, + "owner": { + "title": "Simple User", + "description": "Simple User", "type": "object", "properties": { - "forks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "user": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - } - }, - "url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - } - } - } - }, - "history": { - "type": "array", - "items": { - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "version": { - "type": "string" - }, - "user": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - }, - "nullable": true - }, - "change_status": { - "type": "object", - "properties": { - "deletions": { - "type": "integer" - }, - "additions": { - "type": "integer" - }, - "total": { - "type": "integer" - } - } - }, - "committed_at": { - "type": "string" - } - } - } - }, - "fork_of": { - "nullable": true, - "allOf": [ - { - "title": "Gist Simple", - "description": "Gist Simple", - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string" - }, - "git_push_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "files": { - "type": "object", - "additionalProperties": { - "nullable": true, - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "user": { - "type": "string", - "nullable": true - }, - "comments_url": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "truncated": { - "type": "boolean" - } - } - } - ] - }, - "url": { + "login": { "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/cb5b95fe0f15ada6d34a421007ba2e4a34e2771e\"" - }, - "forks_url": { - "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/forks\"" - }, - "commits_url": { - "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/commits\"" + "example": "octocat" }, "id": { - "type": "string", - "example": "\"d8de7663c84491ba9eeb9ca1fd20ced8\"" - }, - "node_id": { - "type": "string", - "example": "\"MDQ6R2lzdGQ4ZGU3NjYzYzg0NDkxYmE5ZWViOWNhMWZkMjBjZWQ4\"" - }, - "git_pull_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8.git\"" - }, - "git_push_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8.git\"" - }, - "html_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8\"" - }, - "created_at": { - "type": "string", - "example": "\"2020-07-09T00:18:06Z\"" - }, - "updated_at": { - "type": "string", - "example": "\"2020-07-09T00:18:06Z\"" - }, - "description": { - "type": "string", - "example": "\"description\"", - "nullable": true - }, - "comments": { "type": "integer", "example": 1 }, - "comments_url": { + "node_id": { "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/comments\"" + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" } - } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "truncated": { + "type": "boolean" } - ] + } }, "examples": { "default": { @@ -32977,641 +32101,203 @@ "content": { "application/json": { "schema": { - "title": "Gist Full", - "description": "Gist Full", - "allOf": [ - { - "title": "Gist Simple", - "description": "Gist Simple", + "title": "Gist Simple", + "description": "Gist Simple", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "id": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "git_pull_url": { + "type": "string" + }, + "git_push_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "files": { "type": "object", - "properties": { - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string" - }, - "git_push_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "files": { - "type": "object", - "additionalProperties": { - "nullable": true, - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "user": { - "type": "string", - "nullable": true - }, - "comments_url": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } + "additionalProperties": { + "nullable": true, + "type": "object", + "properties": { + "filename": { + "type": "string" }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "truncated": { - "type": "boolean" + "type": { + "type": "string" + }, + "language": { + "type": "string" + }, + "raw_url": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "truncated": { + "type": "boolean" + }, + "content": { + "type": "string" + } } } }, - { + "public": { + "type": "boolean" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "user": { + "type": "string", + "nullable": true + }, + "comments_url": { + "type": "string" + }, + "owner": { + "title": "Simple User", + "description": "Simple User", "type": "object", "properties": { - "forks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "user": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - } - }, - "url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - } - } - } - }, - "history": { - "type": "array", - "items": { - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "version": { - "type": "string" - }, - "user": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - }, - "nullable": true - }, - "change_status": { - "type": "object", - "properties": { - "deletions": { - "type": "integer" - }, - "additions": { - "type": "integer" - }, - "total": { - "type": "integer" - } - } - }, - "committed_at": { - "type": "string" - } - } - } - }, - "fork_of": { - "nullable": true, - "allOf": [ - { - "title": "Gist Simple", - "description": "Gist Simple", - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string" - }, - "git_push_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "files": { - "type": "object", - "additionalProperties": { - "nullable": true, - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "user": { - "type": "string", - "nullable": true - }, - "comments_url": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "truncated": { - "type": "boolean" - } - } - } - ] - }, - "url": { + "login": { "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/cb5b95fe0f15ada6d34a421007ba2e4a34e2771e\"" - }, - "forks_url": { - "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/forks\"" - }, - "commits_url": { - "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/commits\"" + "example": "octocat" }, "id": { - "type": "string", - "example": "\"d8de7663c84491ba9eeb9ca1fd20ced8\"" - }, - "node_id": { - "type": "string", - "example": "\"MDQ6R2lzdGQ4ZGU3NjYzYzg0NDkxYmE5ZWViOWNhMWZkMjBjZWQ4\"" - }, - "git_pull_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8.git\"" - }, - "git_push_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8.git\"" - }, - "html_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8\"" - }, - "created_at": { - "type": "string", - "example": "\"2020-07-09T00:18:06Z\"" - }, - "updated_at": { - "type": "string", - "example": "\"2020-07-09T00:18:06Z\"" - }, - "description": { - "type": "string", - "example": "\"description\"", - "nullable": true - }, - "comments": { "type": "integer", "example": 1 }, - "comments_url": { + "node_id": { "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/comments\"" + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" } - } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "truncated": { + "type": "boolean" } - ] + } }, "examples": { "default": { @@ -35487,651 +34173,253 @@ "schema": { "type": "array", "items": { - "title": "Gist Full", - "description": "Gist Full", - "allOf": [ - { - "title": "Gist Simple", - "description": "Gist Simple", + "title": "Gist Simple", + "description": "Gist Simple", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "id": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "git_pull_url": { + "type": "string" + }, + "git_push_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "files": { "type": "object", - "properties": { - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string" - }, - "git_push_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "files": { - "type": "object", - "additionalProperties": { - "nullable": true, - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "user": { - "type": "string", - "nullable": true - }, - "comments_url": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } + "additionalProperties": { + "nullable": true, + "type": "object", + "properties": { + "filename": { + "type": "string" }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "truncated": { - "type": "boolean" + "type": { + "type": "string" + }, + "language": { + "type": "string" + }, + "raw_url": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "truncated": { + "type": "boolean" + }, + "content": { + "type": "string" + } } } }, - { + "public": { + "type": "boolean" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "user": { + "type": "string", + "nullable": true + }, + "comments_url": { + "type": "string" + }, + "owner": { + "title": "Simple User", + "description": "Simple User", "type": "object", "properties": { - "forks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "user": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - } - }, - "url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - } - } - } - }, - "history": { - "type": "array", - "items": { - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "version": { - "type": "string" - }, - "user": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - }, - "nullable": true - }, - "change_status": { - "type": "object", - "properties": { - "deletions": { - "type": "integer" - }, - "additions": { - "type": "integer" - }, - "total": { - "type": "integer" - } - } - }, - "committed_at": { - "type": "string" - } - } - } - }, - "fork_of": { - "nullable": true, - "allOf": [ - { - "title": "Gist Simple", - "description": "Gist Simple", - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string" - }, - "git_push_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "files": { - "type": "object", - "additionalProperties": { - "nullable": true, - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "user": { - "type": "string", - "nullable": true - }, - "comments_url": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "truncated": { - "type": "boolean" - } - } - } - ] - }, - "url": { + "login": { "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/cb5b95fe0f15ada6d34a421007ba2e4a34e2771e\"" - }, - "forks_url": { - "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/forks\"" - }, - "commits_url": { - "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/commits\"" + "example": "octocat" }, "id": { - "type": "string", - "example": "\"d8de7663c84491ba9eeb9ca1fd20ced8\"" - }, - "node_id": { - "type": "string", - "example": "\"MDQ6R2lzdGQ4ZGU3NjYzYzg0NDkxYmE5ZWViOWNhMWZkMjBjZWQ4\"" - }, - "git_pull_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8.git\"" - }, - "git_push_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8.git\"" - }, - "html_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8\"" - }, - "created_at": { - "type": "string", - "example": "\"2020-07-09T00:18:06Z\"" - }, - "updated_at": { - "type": "string", - "example": "\"2020-07-09T00:18:06Z\"" - }, - "description": { - "type": "string", - "example": "\"description\"", - "nullable": true - }, - "comments": { "type": "integer", "example": 1 }, - "comments_url": { + "node_id": { "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/comments\"" + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" } - } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "truncated": { + "type": "boolean" } - ] + } } }, "examples": { "default": { "value": [ { - "url": "https://api.github.com/gists/dee9c42e4998ce2ea439", - "id": "dee9c42e4998ce2ea439", - "created_at": "2011-04-14T16:00:49Z", - "updated_at": "2011-04-14T16:00:49Z" + "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", + "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks", + "commits_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/commits", + "id": "aa5a315d61ae9438b18d", + "node_id": "MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk", + "git_pull_url": "https://gist.github.com/aa5a315d61ae9438b18d.git", + "git_push_url": "https://gist.github.com/aa5a315d61ae9438b18d.git", + "html_url": "https://gist.github.com/aa5a315d61ae9438b18d", + "files": { + "hello_world.rb": { + "filename": "hello_world.rb", + "type": "application/x-ruby", + "language": "Ruby", + "raw_url": "https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb", + "size": 167 + } + }, + "public": true, + "created_at": "2010-04-14T02:15:15Z", + "updated_at": "2011-06-20T11:34:15Z", + "description": "Hello World Examples", + "comments": 1, + "user": null, + "comments_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/comments/", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } } ] } @@ -37033,641 +35321,203 @@ "content": { "application/json": { "schema": { - "title": "Gist Full", - "description": "Gist Full", - "allOf": [ - { - "title": "Gist Simple", - "description": "Gist Simple", + "title": "Gist Simple", + "description": "Gist Simple", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "id": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "git_pull_url": { + "type": "string" + }, + "git_push_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "files": { "type": "object", - "properties": { - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string" - }, - "git_push_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "files": { - "type": "object", - "additionalProperties": { - "nullable": true, - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "user": { - "type": "string", - "nullable": true - }, - "comments_url": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } + "additionalProperties": { + "nullable": true, + "type": "object", + "properties": { + "filename": { + "type": "string" }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "truncated": { - "type": "boolean" + "type": { + "type": "string" + }, + "language": { + "type": "string" + }, + "raw_url": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "truncated": { + "type": "boolean" + }, + "content": { + "type": "string" + } } } }, - { + "public": { + "type": "boolean" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "user": { + "type": "string", + "nullable": true + }, + "comments_url": { + "type": "string" + }, + "owner": { + "title": "Simple User", + "description": "Simple User", "type": "object", "properties": { - "forks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "user": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - } - }, - "url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - } - } - } - }, - "history": { - "type": "array", - "items": { - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "version": { - "type": "string" - }, - "user": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - }, - "nullable": true - }, - "change_status": { - "type": "object", - "properties": { - "deletions": { - "type": "integer" - }, - "additions": { - "type": "integer" - }, - "total": { - "type": "integer" - } - } - }, - "committed_at": { - "type": "string" - } - } - } - }, - "fork_of": { - "nullable": true, - "allOf": [ - { - "title": "Gist Simple", - "description": "Gist Simple", - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string" - }, - "git_push_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "files": { - "type": "object", - "additionalProperties": { - "nullable": true, - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "user": { - "type": "string", - "nullable": true - }, - "comments_url": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "truncated": { - "type": "boolean" - } - } - } - ] - }, - "url": { + "login": { "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/cb5b95fe0f15ada6d34a421007ba2e4a34e2771e\"" - }, - "forks_url": { - "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/forks\"" - }, - "commits_url": { - "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/commits\"" + "example": "octocat" }, "id": { - "type": "string", - "example": "\"d8de7663c84491ba9eeb9ca1fd20ced8\"" - }, - "node_id": { - "type": "string", - "example": "\"MDQ6R2lzdGQ4ZGU3NjYzYzg0NDkxYmE5ZWViOWNhMWZkMjBjZWQ4\"" - }, - "git_pull_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8.git\"" - }, - "git_push_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8.git\"" - }, - "html_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8\"" - }, - "created_at": { - "type": "string", - "example": "\"2020-07-09T00:18:06Z\"" - }, - "updated_at": { - "type": "string", - "example": "\"2020-07-09T00:18:06Z\"" - }, - "description": { - "type": "string", - "example": "\"description\"", - "nullable": true - }, - "comments": { "type": "integer", "example": 1 }, - "comments_url": { + "node_id": { "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/comments\"" + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" } - } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "truncated": { + "type": "boolean" } - ] + } }, "examples": { "default": { @@ -76277,7 +74127,7 @@ }, "post": { "summary": "Create a discussion", - "description": "Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@3.0/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\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@3.0/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@3.0/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`.", + "description": "Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@3.0/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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@3.0/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@3.0/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`.", "tags": [ "teams" ], @@ -77928,7 +75778,7 @@ }, "post": { "summary": "Create a discussion comment", - "description": "Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@3.0/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\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@3.0/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@3.0/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.", + "description": "Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@3.0/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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@3.0/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@3.0/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.", "tags": [ "teams" ], @@ -139400,7 +137250,7 @@ }, "put": { "summary": "Add a repository collaborator", - "description": "This 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@3.0/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@3.0/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\nFor more information the permission levels, see \"[Repository permission levels for an organization](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@3.0/rest/overview/resources-in-the-rest-api#http-verbs).\"\n\nThe invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [repository invitations API endpoints](https://docs.github.com/enterprise-server@3.0/rest/reference/repos#invitations).\n\n**Rate limits**\n\nTo prevent abuse, you are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.", + "description": "This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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@3.0/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@3.0/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\nFor more information the permission levels, see \"[Repository permission levels for an organization](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@3.0/rest/overview/resources-in-the-rest-api#http-verbs).\"\n\nThe invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [repository invitations API endpoints](https://docs.github.com/enterprise-server@3.0/rest/reference/repos#invitations).\n\n**Rate limits**\n\nTo prevent abuse, you are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.", "tags": [ "repos" ], @@ -145251,7 +143101,7 @@ }, "post": { "summary": "Create a commit comment", - "description": "Create a comment for a commit using its `:commit_sha`.\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@3.0/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@3.0/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", + "description": "Create a comment for a commit using its `:commit_sha`.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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@3.0/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@3.0/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", "tags": [ "repos" ], @@ -181477,7 +179327,7 @@ }, "post": { "summary": "Create an issue", - "description": "Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://help.github.com/articles/disabling-issues/), the API returns a `410 Gone` status.\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@3.0/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@3.0/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)\" for details.", + "description": "Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://help.github.com/articles/disabling-issues/), the API returns a `410 Gone` status.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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@3.0/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@3.0/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)\" for details.", "tags": [ "issues" ], @@ -203697,7 +201547,7 @@ }, "post": { "summary": "Create an issue comment", - "description": "This 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@3.0/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@3.0/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)\" for details.", + "description": "This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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@3.0/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@3.0/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)\" for details.", "tags": [ "issues" ], @@ -220123,7 +217973,7 @@ }, "post": { "summary": "Create a pull request", - "description": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.\n\nYou can create a new pull request.\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@3.0/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@3.0/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", + "description": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.\n\nYou can create a new pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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@3.0/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@3.0/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", "tags": [ "pulls" ], @@ -232775,7 +230625,7 @@ }, "post": { "summary": "Create a review comment for a pull request", - "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@3.0/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@3.0/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@3.0/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@3.0/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", + "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@3.0/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@3.0/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://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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@3.0/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@3.0/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", "tags": [ "pulls" ], @@ -233453,7 +231303,7 @@ "/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies": { "post": { "summary": "Create a reply for a review comment", - "description": "Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported.\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@3.0/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@3.0/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", + "description": "Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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@3.0/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@3.0/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", "tags": [ "pulls" ], @@ -240033,7 +237883,7 @@ }, "post": { "summary": "Create a review for a pull request", - "description": "This 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@3.0/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@3.0/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\nPull request reviews created in the `PENDING` state do not include the `submitted_at` property in the response.\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API v3 offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/enterprise-server@3.0/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/enterprise-server@3.0/rest/reference/pulls#get-a-pull-request) endpoint.\n\nThe `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.", + "description": "This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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@3.0/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@3.0/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\nPull request reviews created in the `PENDING` state do not include the `submitted_at` property in the response.\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API v3 offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/enterprise-server@3.0/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/enterprise-server@3.0/rest/reference/pulls#get-a-pull-request) endpoint.\n\nThe `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.", "tags": [ "pulls" ], @@ -243914,7 +241764,7 @@ }, "post": { "summary": "Create a release", - "description": "Users with push access to the repository can create a release.\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@3.0/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@3.0/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", + "description": "Users with push access to the repository can create a release.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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@3.0/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@3.0/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", "tags": [ "repos" ], @@ -266480,7 +264330,7 @@ }, "post": { "summary": "Create a discussion (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/enterprise-server@3.0/rest/reference/teams#create-a-discussion) endpoint.\n\nCreates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@3.0/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\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@3.0/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@3.0/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/enterprise-server@3.0/rest/reference/teams#create-a-discussion) endpoint.\n\nCreates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@3.0/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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@3.0/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@3.0/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", "tags": [ "teams" ], @@ -268101,7 +265951,7 @@ }, "post": { "summary": "Create a discussion comment (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/enterprise-server@3.0/rest/reference/teams#create-a-discussion-comment) endpoint.\n\nCreates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@3.0/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\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@3.0/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@3.0/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/enterprise-server@3.0/rest/reference/teams#create-a-discussion-comment) endpoint.\n\nCreates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@3.0/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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@3.0/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@3.0/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", "tags": [ "teams" ], diff --git a/lib/rest/static/dereferenced/github.ae.deref.json b/lib/rest/static/dereferenced/github.ae.deref.json index 331dfd8e68..3b33a9f69b 100644 --- a/lib/rest/static/dereferenced/github.ae.deref.json +++ b/lib/rest/static/dereferenced/github.ae.deref.json @@ -16374,641 +16374,203 @@ "content": { "application/json": { "schema": { - "title": "Gist Full", - "description": "Gist Full", - "allOf": [ - { - "title": "Gist Simple", - "description": "Gist Simple", + "title": "Gist Simple", + "description": "Gist Simple", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "id": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "git_pull_url": { + "type": "string" + }, + "git_push_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "files": { "type": "object", - "properties": { - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string" - }, - "git_push_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "files": { - "type": "object", - "additionalProperties": { - "nullable": true, - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "user": { - "type": "string", - "nullable": true - }, - "comments_url": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } + "additionalProperties": { + "nullable": true, + "type": "object", + "properties": { + "filename": { + "type": "string" }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "truncated": { - "type": "boolean" + "type": { + "type": "string" + }, + "language": { + "type": "string" + }, + "raw_url": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "truncated": { + "type": "boolean" + }, + "content": { + "type": "string" + } } } }, - { + "public": { + "type": "boolean" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "user": { + "type": "string", + "nullable": true + }, + "comments_url": { + "type": "string" + }, + "owner": { + "title": "Simple User", + "description": "Simple User", "type": "object", "properties": { - "forks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "user": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - } - }, - "url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - } - } - } - }, - "history": { - "type": "array", - "items": { - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "version": { - "type": "string" - }, - "user": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - }, - "nullable": true - }, - "change_status": { - "type": "object", - "properties": { - "deletions": { - "type": "integer" - }, - "additions": { - "type": "integer" - }, - "total": { - "type": "integer" - } - } - }, - "committed_at": { - "type": "string" - } - } - } - }, - "fork_of": { - "nullable": true, - "allOf": [ - { - "title": "Gist Simple", - "description": "Gist Simple", - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string" - }, - "git_push_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "files": { - "type": "object", - "additionalProperties": { - "nullable": true, - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "user": { - "type": "string", - "nullable": true - }, - "comments_url": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "truncated": { - "type": "boolean" - } - } - } - ] - }, - "url": { + "login": { "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/cb5b95fe0f15ada6d34a421007ba2e4a34e2771e\"" - }, - "forks_url": { - "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/forks\"" - }, - "commits_url": { - "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/commits\"" + "example": "octocat" }, "id": { - "type": "string", - "example": "\"d8de7663c84491ba9eeb9ca1fd20ced8\"" - }, - "node_id": { - "type": "string", - "example": "\"MDQ6R2lzdGQ4ZGU3NjYzYzg0NDkxYmE5ZWViOWNhMWZkMjBjZWQ4\"" - }, - "git_pull_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8.git\"" - }, - "git_push_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8.git\"" - }, - "html_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8\"" - }, - "created_at": { - "type": "string", - "example": "\"2020-07-09T00:18:06Z\"" - }, - "updated_at": { - "type": "string", - "example": "\"2020-07-09T00:18:06Z\"" - }, - "description": { - "type": "string", - "example": "\"description\"", - "nullable": true - }, - "comments": { "type": "integer", "example": 1 }, - "comments_url": { + "node_id": { "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/comments\"" + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" } - } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "truncated": { + "type": "boolean" } - ] + } }, "examples": { "default": { @@ -18272,641 +17834,203 @@ "content": { "application/json": { "schema": { - "title": "Gist Full", - "description": "Gist Full", - "allOf": [ - { - "title": "Gist Simple", - "description": "Gist Simple", + "title": "Gist Simple", + "description": "Gist Simple", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "id": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "git_pull_url": { + "type": "string" + }, + "git_push_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "files": { "type": "object", - "properties": { - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string" - }, - "git_push_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "files": { - "type": "object", - "additionalProperties": { - "nullable": true, - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "user": { - "type": "string", - "nullable": true - }, - "comments_url": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } + "additionalProperties": { + "nullable": true, + "type": "object", + "properties": { + "filename": { + "type": "string" }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "truncated": { - "type": "boolean" + "type": { + "type": "string" + }, + "language": { + "type": "string" + }, + "raw_url": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "truncated": { + "type": "boolean" + }, + "content": { + "type": "string" + } } } }, - { + "public": { + "type": "boolean" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "user": { + "type": "string", + "nullable": true + }, + "comments_url": { + "type": "string" + }, + "owner": { + "title": "Simple User", + "description": "Simple User", "type": "object", "properties": { - "forks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "user": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - } - }, - "url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - } - } - } - }, - "history": { - "type": "array", - "items": { - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "version": { - "type": "string" - }, - "user": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - }, - "nullable": true - }, - "change_status": { - "type": "object", - "properties": { - "deletions": { - "type": "integer" - }, - "additions": { - "type": "integer" - }, - "total": { - "type": "integer" - } - } - }, - "committed_at": { - "type": "string" - } - } - } - }, - "fork_of": { - "nullable": true, - "allOf": [ - { - "title": "Gist Simple", - "description": "Gist Simple", - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string" - }, - "git_push_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "files": { - "type": "object", - "additionalProperties": { - "nullable": true, - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "user": { - "type": "string", - "nullable": true - }, - "comments_url": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "truncated": { - "type": "boolean" - } - } - } - ] - }, - "url": { + "login": { "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/cb5b95fe0f15ada6d34a421007ba2e4a34e2771e\"" - }, - "forks_url": { - "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/forks\"" - }, - "commits_url": { - "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/commits\"" + "example": "octocat" }, "id": { - "type": "string", - "example": "\"d8de7663c84491ba9eeb9ca1fd20ced8\"" - }, - "node_id": { - "type": "string", - "example": "\"MDQ6R2lzdGQ4ZGU3NjYzYzg0NDkxYmE5ZWViOWNhMWZkMjBjZWQ4\"" - }, - "git_pull_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8.git\"" - }, - "git_push_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8.git\"" - }, - "html_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8\"" - }, - "created_at": { - "type": "string", - "example": "\"2020-07-09T00:18:06Z\"" - }, - "updated_at": { - "type": "string", - "example": "\"2020-07-09T00:18:06Z\"" - }, - "description": { - "type": "string", - "example": "\"description\"", - "nullable": true - }, - "comments": { "type": "integer", "example": 1 }, - "comments_url": { + "node_id": { "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/comments\"" + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" } - } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "truncated": { + "type": "boolean" } - ] + } }, "examples": { "default": { @@ -19080,641 +18204,203 @@ "content": { "application/json": { "schema": { - "title": "Gist Full", - "description": "Gist Full", - "allOf": [ - { - "title": "Gist Simple", - "description": "Gist Simple", + "title": "Gist Simple", + "description": "Gist Simple", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "id": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "git_pull_url": { + "type": "string" + }, + "git_push_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "files": { "type": "object", - "properties": { - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string" - }, - "git_push_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "files": { - "type": "object", - "additionalProperties": { - "nullable": true, - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "user": { - "type": "string", - "nullable": true - }, - "comments_url": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } + "additionalProperties": { + "nullable": true, + "type": "object", + "properties": { + "filename": { + "type": "string" }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "truncated": { - "type": "boolean" + "type": { + "type": "string" + }, + "language": { + "type": "string" + }, + "raw_url": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "truncated": { + "type": "boolean" + }, + "content": { + "type": "string" + } } } }, - { + "public": { + "type": "boolean" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "user": { + "type": "string", + "nullable": true + }, + "comments_url": { + "type": "string" + }, + "owner": { + "title": "Simple User", + "description": "Simple User", "type": "object", "properties": { - "forks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "user": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - } - }, - "url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - } - } - } - }, - "history": { - "type": "array", - "items": { - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "version": { - "type": "string" - }, - "user": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - }, - "nullable": true - }, - "change_status": { - "type": "object", - "properties": { - "deletions": { - "type": "integer" - }, - "additions": { - "type": "integer" - }, - "total": { - "type": "integer" - } - } - }, - "committed_at": { - "type": "string" - } - } - } - }, - "fork_of": { - "nullable": true, - "allOf": [ - { - "title": "Gist Simple", - "description": "Gist Simple", - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string" - }, - "git_push_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "files": { - "type": "object", - "additionalProperties": { - "nullable": true, - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "user": { - "type": "string", - "nullable": true - }, - "comments_url": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "truncated": { - "type": "boolean" - } - } - } - ] - }, - "url": { + "login": { "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/cb5b95fe0f15ada6d34a421007ba2e4a34e2771e\"" - }, - "forks_url": { - "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/forks\"" - }, - "commits_url": { - "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/commits\"" + "example": "octocat" }, "id": { - "type": "string", - "example": "\"d8de7663c84491ba9eeb9ca1fd20ced8\"" - }, - "node_id": { - "type": "string", - "example": "\"MDQ6R2lzdGQ4ZGU3NjYzYzg0NDkxYmE5ZWViOWNhMWZkMjBjZWQ4\"" - }, - "git_pull_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8.git\"" - }, - "git_push_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8.git\"" - }, - "html_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8\"" - }, - "created_at": { - "type": "string", - "example": "\"2020-07-09T00:18:06Z\"" - }, - "updated_at": { - "type": "string", - "example": "\"2020-07-09T00:18:06Z\"" - }, - "description": { - "type": "string", - "example": "\"description\"", - "nullable": true - }, - "comments": { "type": "integer", "example": 1 }, - "comments_url": { + "node_id": { "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/comments\"" + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" } - } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "truncated": { + "type": "boolean" } - ] + } }, "examples": { "default": { @@ -21590,651 +20276,253 @@ "schema": { "type": "array", "items": { - "title": "Gist Full", - "description": "Gist Full", - "allOf": [ - { - "title": "Gist Simple", - "description": "Gist Simple", + "title": "Gist Simple", + "description": "Gist Simple", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "id": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "git_pull_url": { + "type": "string" + }, + "git_push_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "files": { "type": "object", - "properties": { - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string" - }, - "git_push_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "files": { - "type": "object", - "additionalProperties": { - "nullable": true, - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "user": { - "type": "string", - "nullable": true - }, - "comments_url": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } + "additionalProperties": { + "nullable": true, + "type": "object", + "properties": { + "filename": { + "type": "string" }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "truncated": { - "type": "boolean" + "type": { + "type": "string" + }, + "language": { + "type": "string" + }, + "raw_url": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "truncated": { + "type": "boolean" + }, + "content": { + "type": "string" + } } } }, - { + "public": { + "type": "boolean" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "user": { + "type": "string", + "nullable": true + }, + "comments_url": { + "type": "string" + }, + "owner": { + "title": "Simple User", + "description": "Simple User", "type": "object", "properties": { - "forks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "user": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - } - }, - "url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - } - } - } - }, - "history": { - "type": "array", - "items": { - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "version": { - "type": "string" - }, - "user": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - }, - "nullable": true - }, - "change_status": { - "type": "object", - "properties": { - "deletions": { - "type": "integer" - }, - "additions": { - "type": "integer" - }, - "total": { - "type": "integer" - } - } - }, - "committed_at": { - "type": "string" - } - } - } - }, - "fork_of": { - "nullable": true, - "allOf": [ - { - "title": "Gist Simple", - "description": "Gist Simple", - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string" - }, - "git_push_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "files": { - "type": "object", - "additionalProperties": { - "nullable": true, - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "user": { - "type": "string", - "nullable": true - }, - "comments_url": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "truncated": { - "type": "boolean" - } - } - } - ] - }, - "url": { + "login": { "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/cb5b95fe0f15ada6d34a421007ba2e4a34e2771e\"" - }, - "forks_url": { - "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/forks\"" - }, - "commits_url": { - "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/commits\"" + "example": "octocat" }, "id": { - "type": "string", - "example": "\"d8de7663c84491ba9eeb9ca1fd20ced8\"" - }, - "node_id": { - "type": "string", - "example": "\"MDQ6R2lzdGQ4ZGU3NjYzYzg0NDkxYmE5ZWViOWNhMWZkMjBjZWQ4\"" - }, - "git_pull_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8.git\"" - }, - "git_push_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8.git\"" - }, - "html_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8\"" - }, - "created_at": { - "type": "string", - "example": "\"2020-07-09T00:18:06Z\"" - }, - "updated_at": { - "type": "string", - "example": "\"2020-07-09T00:18:06Z\"" - }, - "description": { - "type": "string", - "example": "\"description\"", - "nullable": true - }, - "comments": { "type": "integer", "example": 1 }, - "comments_url": { + "node_id": { "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/comments\"" + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" } - } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "truncated": { + "type": "boolean" } - ] + } } }, "examples": { "default": { "value": [ { - "url": "https://api.github.com/gists/dee9c42e4998ce2ea439", - "id": "dee9c42e4998ce2ea439", - "created_at": "2011-04-14T16:00:49Z", - "updated_at": "2011-04-14T16:00:49Z" + "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", + "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks", + "commits_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/commits", + "id": "aa5a315d61ae9438b18d", + "node_id": "MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk", + "git_pull_url": "https://gist.github.com/aa5a315d61ae9438b18d.git", + "git_push_url": "https://gist.github.com/aa5a315d61ae9438b18d.git", + "html_url": "https://gist.github.com/aa5a315d61ae9438b18d", + "files": { + "hello_world.rb": { + "filename": "hello_world.rb", + "type": "application/x-ruby", + "language": "Ruby", + "raw_url": "https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb", + "size": 167 + } + }, + "public": true, + "created_at": "2010-04-14T02:15:15Z", + "updated_at": "2011-06-20T11:34:15Z", + "description": "Hello World Examples", + "comments": 1, + "user": null, + "comments_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/comments/", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } } ] } @@ -23136,641 +21424,203 @@ "content": { "application/json": { "schema": { - "title": "Gist Full", - "description": "Gist Full", - "allOf": [ - { - "title": "Gist Simple", - "description": "Gist Simple", + "title": "Gist Simple", + "description": "Gist Simple", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "id": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "git_pull_url": { + "type": "string" + }, + "git_push_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "files": { "type": "object", - "properties": { - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string" - }, - "git_push_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "files": { - "type": "object", - "additionalProperties": { - "nullable": true, - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "user": { - "type": "string", - "nullable": true - }, - "comments_url": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } + "additionalProperties": { + "nullable": true, + "type": "object", + "properties": { + "filename": { + "type": "string" }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "truncated": { - "type": "boolean" + "type": { + "type": "string" + }, + "language": { + "type": "string" + }, + "raw_url": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "truncated": { + "type": "boolean" + }, + "content": { + "type": "string" + } } } }, - { + "public": { + "type": "boolean" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "user": { + "type": "string", + "nullable": true + }, + "comments_url": { + "type": "string" + }, + "owner": { + "title": "Simple User", + "description": "Simple User", "type": "object", "properties": { - "forks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "user": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - } - }, - "url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - } - } - } - }, - "history": { - "type": "array", - "items": { - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "version": { - "type": "string" - }, - "user": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - }, - "nullable": true - }, - "change_status": { - "type": "object", - "properties": { - "deletions": { - "type": "integer" - }, - "additions": { - "type": "integer" - }, - "total": { - "type": "integer" - } - } - }, - "committed_at": { - "type": "string" - } - } - } - }, - "fork_of": { - "nullable": true, - "allOf": [ - { - "title": "Gist Simple", - "description": "Gist Simple", - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string" - }, - "git_push_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "files": { - "type": "object", - "additionalProperties": { - "nullable": true, - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "user": { - "type": "string", - "nullable": true - }, - "comments_url": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "truncated": { - "type": "boolean" - } - } - } - ] - }, - "url": { + "login": { "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/cb5b95fe0f15ada6d34a421007ba2e4a34e2771e\"" - }, - "forks_url": { - "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/forks\"" - }, - "commits_url": { - "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/commits\"" + "example": "octocat" }, "id": { - "type": "string", - "example": "\"d8de7663c84491ba9eeb9ca1fd20ced8\"" - }, - "node_id": { - "type": "string", - "example": "\"MDQ6R2lzdGQ4ZGU3NjYzYzg0NDkxYmE5ZWViOWNhMWZkMjBjZWQ4\"" - }, - "git_pull_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8.git\"" - }, - "git_push_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8.git\"" - }, - "html_url": { - "type": "string", - "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8\"" - }, - "created_at": { - "type": "string", - "example": "\"2020-07-09T00:18:06Z\"" - }, - "updated_at": { - "type": "string", - "example": "\"2020-07-09T00:18:06Z\"" - }, - "description": { - "type": "string", - "example": "\"description\"", - "nullable": true - }, - "comments": { "type": "integer", "example": 1 }, - "comments_url": { + "node_id": { "type": "string", - "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/comments\"" + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" } - } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "truncated": { + "type": "boolean" } - ] + } }, "examples": { "default": { @@ -53243,7 +51093,7 @@ }, "post": { "summary": "Create a discussion", - "description": "Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\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**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`.", + "description": "Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`.", "tags": [ "teams" ], @@ -54894,7 +52744,7 @@ }, "post": { "summary": "Create a discussion comment", - "description": "Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\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**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.", + "description": "Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.", "tags": [ "teams" ], @@ -98515,7 +96365,7 @@ }, "put": { "summary": "Add a repository collaborator", - "description": "This 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\nFor more information the permission levels, see \"[Repository permission levels for an organization](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#http-verbs).\"\n\nThe invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [repository invitations API endpoints](https://docs.github.com/github-ae@latest/rest/reference/repos#invitations).\n\n**Rate limits**\n\nTo prevent abuse, you are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.", + "description": "This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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\nFor more information the permission levels, see \"[Repository permission levels for an organization](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#http-verbs).\"\n\nThe invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [repository invitations API endpoints](https://docs.github.com/github-ae@latest/rest/reference/repos#invitations).\n\n**Rate limits**\n\nTo prevent abuse, you are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.", "tags": [ "repos" ], @@ -104366,7 +102216,7 @@ }, "post": { "summary": "Create a commit comment", - "description": "Create a comment for a commit using its `:commit_sha`.\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.", + "description": "Create a comment for a commit using its `:commit_sha`.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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": [ "repos" ], @@ -140592,7 +138442,7 @@ }, "post": { "summary": "Create an issue", - "description": "Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://help.github.com/articles/disabling-issues/), the API returns a `410 Gone` status.\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-abuse-rate-limits)\" for details.", + "description": "Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://help.github.com/articles/disabling-issues/), the API returns a `410 Gone` status.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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-abuse-rate-limits)\" for details.", "tags": [ "issues" ], @@ -162812,7 +160662,7 @@ }, "post": { "summary": "Create an issue comment", - "description": "This 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-abuse-rate-limits)\" for details.", + "description": "This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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-abuse-rate-limits)\" for details.", "tags": [ "issues" ], @@ -178853,7 +176703,7 @@ }, "post": { "summary": "Create a pull request", - "description": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.\n\nYou can create a new pull request.\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.", + "description": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.\n\nYou can create a new pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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" ], @@ -191505,7 +189355,7 @@ }, "post": { "summary": "Create a review comment for a pull request", - "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.", + "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://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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" ], @@ -192183,7 +190033,7 @@ "/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies": { "post": { "summary": "Create a reply for a review comment", - "description": "Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported.\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.", + "description": "Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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" ], @@ -198763,7 +196613,7 @@ }, "post": { "summary": "Create a review for a pull request", - "description": "This 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\nPull request reviews created in the `PENDING` state do not include the `submitted_at` property in the response.\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API v3 offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/github-ae@latest/rest/reference/pulls#get-a-pull-request) endpoint.\n\nThe `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.", + "description": "This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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\nPull request reviews created in the `PENDING` state do not include the `submitted_at` property in the response.\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API v3 offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/github-ae@latest/rest/reference/pulls#get-a-pull-request) endpoint.\n\nThe `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.", "tags": [ "pulls" ], @@ -202644,7 +200494,7 @@ }, "post": { "summary": "Create a release", - "description": "Users with push access to the repository can create a release.\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.", + "description": "Users with push access to the repository can create a release.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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": [ "repos" ], @@ -223924,7 +221774,7 @@ }, "post": { "summary": "Create a discussion (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/github-ae@latest/rest/reference/teams#create-a-discussion) endpoint.\n\nCreates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\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.", + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/github-ae@latest/rest/reference/teams#create-a-discussion) endpoint.\n\nCreates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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": [ "teams" ], @@ -225545,7 +223395,7 @@ }, "post": { "summary": "Create a discussion comment (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/github-ae@latest/rest/reference/teams#create-a-discussion-comment) endpoint.\n\nCreates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\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.", + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/github-ae@latest/rest/reference/teams#create-a-discussion-comment) endpoint.\n\nCreates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/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": [ "teams" ], From c21a738e95e46dc96cb067009f0be634ff569fc5 Mon Sep 17 00:00:00 2001 From: Kevin Heis Date: Wed, 20 Jan 2021 08:20:32 -0800 Subject: [PATCH 18/21] Make browser search tests green (#17385) * Make browser search tests green * Okay... lodash get then _Linter_ ugh --- middleware/search.js | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/middleware/search.js b/middleware/search.js index 262d4216df..a9e6296688 100644 --- a/middleware/search.js +++ b/middleware/search.js @@ -3,6 +3,7 @@ const algoliasearch = require('algoliasearch') const { namePrefix } = require('../lib/search/config') const languages = new Set(Object.keys(require('../lib/languages'))) const versions = require('../lib/search/versions') +const { get } = require('lodash') const router = express.Router() @@ -23,10 +24,10 @@ async function loadAlgoliaResults ({ version, language, query, limit }) { return hits.map(hit => ({ url: hit.url, - breadcrumbs: hit._highlightResult.breadcrumbs.value, - heading: hit._highlightResult.heading.value, - title: hit._highlightResult.title.value, - content: hit._highlightResult.content.value + breadcrumbs: get(hit, '_highlightResult.breadcrumbs.value'), + heading: get(hit, '_highlightResult.heading.value'), + title: get(hit, '_highlightResult.title.value'), + content: get(hit, '_highlightResult.content.value') })) } From 0a2c19fb9613d1540a16f5c4b8460d8ac529f186 Mon Sep 17 00:00:00 2001 From: Cynthia Rich Date: Wed, 20 Jan 2021 12:03:47 -0500 Subject: [PATCH 19/21] Manually update landing pages (#17312) * add new discussions video * add changelog posts for actions and packages * remove unused getting started from yaml * update popular actions articles * update popular packages pages * Fix changelog post date --- content/actions/index.md | 13 +++++-------- content/discussions/index.md | 2 +- content/packages/index.md | 9 +++++---- 3 files changed, 11 insertions(+), 13 deletions(-) diff --git a/content/actions/index.md b/content/actions/index.md index 75e30f185f..85d2a1ac54 100644 --- a/content/actions/index.md +++ b/content/actions/index.md @@ -10,30 +10,27 @@ featuredLinks: - /actions/learn-github-actions - /actions/guides/about-continuous-integration - /actions/guides/about-packaging-with-github-actions - gettingStarted: - - /actions/managing-workflow-runs - - /actions/hosting-your-own-runners guideCards: - /actions/guides/setting-up-continuous-integration-using-workflow-templates - /actions/guides/publishing-nodejs-packages - /actions/guides/building-and-testing-powershell popular: - /actions/reference/workflow-syntax-for-github-actions - - /actions/reference/events-that-trigger-workflows - /actions/learn-github-actions + - /actions/reference/events-that-trigger-workflows - /actions/reference/context-and-expression-syntax-for-github-actions - - /actions/reference/workflow-commands-for-github-actions - /actions/reference/environment-variables + - /actions/reference/encrypted-secrets changelog: + - title: Environments, environment protection rules and environment secrets (beta) + date: '2020-12-15' + href: https://github.blog/changelog/2020-12-15-github-actions-environments-environment-protection-rules-and-environment-secrets-beta/ - title: Workflow visualization date: '2020-12-08' href: https://github.blog/changelog/2020-12-08-github-actions-workflow-visualization/ - title: Removing set-env and add-path commands on November 16 date: '2020-11-09' href: https://github.blog/changelog/2020-10-01-github-actions-deprecating-set-env-and-add-path-commands/ - - title: Ubuntu-latest workflows will use Ubuntu-20.04 - date: '2020-10-29' - href: https://github.blog/changelog/2020-10-29-github-actions-ubuntu-latest-workflows-will-use-ubuntu-20-04 product_video: https://www.youtube-nocookie.com/embed/cP0I9w2coGU diff --git a/content/discussions/index.md b/content/discussions/index.md index 902d7f2a00..429f32ddbd 100644 --- a/content/discussions/index.md +++ b/content/discussions/index.md @@ -22,7 +22,7 @@ featuredLinks: - /discussions/guides/finding-discussions-across-multiple-repositories - /discussions/collaborating-with-your-community-using-discussions/collaborating-with-maintainers-using-discussions - /discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository -product_video: https://www.youtube-nocookie.com/embed/DbTWBP3_RbM +product_video: https://www.youtube-nocookie.com/embed/IpBw2SJkFyk layout: product-landing versions: free-pro-team: '*' diff --git a/content/packages/index.md b/content/packages/index.md index 6460466af0..46b6102074 100644 --- a/content/packages/index.md +++ b/content/packages/index.md @@ -12,22 +12,23 @@ featuredLinks: - /packages/manage-packages/installing-a-package popular: - /packages/guides/configuring-npm-for-use-with-github-packages - - /packages/learn-github-packages/about-github-packages + - /packages/guides/configuring-docker-for-use-with-github-packages + - /packages/learn-github-packages - /packages/guides/configuring-apache-maven-for-use-with-github-packages guideCards: - /packages/guides/configuring-npm-for-use-with-github-packages - /packages/guides/enabling-improved-container-support - /packages/guides/configuring-rubygems-for-use-with-github-packages changelog: + - title: ghcr.io maintenance mode on 2021-01-09 + date: '2021-01-08' + href: https://github.blog/changelog/2021-01-08-packages-ghcr-io-maintenance-mode-on-2021-01-09/ - title: ghcr.io container names redirect to the container page date: '2020-12-14' href: https://github.blog/changelog/2020-12-14-ghcr-io-container-names-redirect-to-the-container-page/ - title: Filter for tagged and untagged containers date: '2020-12-14' href: https://github.blog/changelog/2020-12-14-packages-can-filter-for-tagged-and-untagged-containers/ - - title: Packages container support is an opt-in beta - date: '2020-11-17' - href: https://docs.github.com/packages/getting-started-with-github-container-registry/enabling-improved-container-support redirect_from: - /github/managing-packages-with-github-packages - /categories/managing-packages-with-github-package-registry From 9805b414b11da0d4a8e106a6509f01754135bab4 Mon Sep 17 00:00:00 2001 From: Jon Ruskin Date: Wed, 20 Jan 2021 11:21:11 -0700 Subject: [PATCH 20/21] Add insights pre-requisite on netcat (#17355) Co-authored-by: Laura Coursen --- .../installing-github-insights.md | 1 + 1 file changed, 1 insertion(+) diff --git a/content/insights/installing-and-configuring-github-insights/installing-github-insights.md b/content/insights/installing-and-configuring-github-insights/installing-github-insights.md index 5bc8e0c745..18658d914d 100644 --- a/content/insights/installing-and-configuring-github-insights/installing-github-insights.md +++ b/content/insights/installing-and-configuring-github-insights/installing-github-insights.md @@ -16,6 +16,7 @@ versions: - You must install dependencies on the application server. - [Docker](https://docs.docker.com/install/) 1.13.0+ - [Docker Compose](https://docs.docker.com/compose/install/) v1.17.0+ + - [netcat](http://netcat.sourceforge.net/), available via apt for [Debian](https://packages.debian.org/search?keywords=netcat) and [Ubuntu](https://packages.ubuntu.com/search?keywords=netcat&searchon=names) {% note %} From 6c3788cde0136bb4591d627dd976593d4092eb86 Mon Sep 17 00:00:00 2001 From: Cynthia Rich Date: Wed, 20 Jan 2021 14:31:07 -0500 Subject: [PATCH 21/21] Add code block copy button to more actions guides code blocks (#16213) * add copy to code blocks in about service containers * add copy to code blocks in java with ant guide * add copy to code blocks in actions guides * Update content/actions/guides/about-service-containers.md Co-authored-by: Jason Etcovitch * {:code} should be {:copy} * add copy button in reusable Co-authored-by: Jason Etcovitch --- .../guides/about-service-containers.md | 4 ++-- .../building-and-testing-java-with-ant.md | 6 ++--- .../building-and-testing-java-with-gradle.md | 8 +++---- .../building-and-testing-java-with-maven.md | 8 +++---- .../guides/building-and-testing-nodejs.md | 20 ++++++++-------- .../guides/building-and-testing-python.md | 24 +++++++++---------- ...hing-dependencies-to-speed-up-workflows.md | 2 +- .../creating-postgresql-service-containers.md | 14 +++++------ .../creating-redis-service-containers.md | 14 +++++------ .../guides/publishing-docker-images.md | 6 ++--- .../publishing-java-packages-with-gradle.md | 12 +++++----- .../publishing-java-packages-with-maven.md | 10 ++++---- .../guides/publishing-nodejs-packages.md | 8 +++---- .../storing-workflow-data-as-artifacts.md | 6 ++--- .../github-actions/java-jvm-architecture.md | 2 +- 15 files changed, 72 insertions(+), 72 deletions(-) diff --git a/content/actions/guides/about-service-containers.md b/content/actions/guides/about-service-containers.md index a91914c527..ceaed1b507 100644 --- a/content/actions/guides/about-service-containers.md +++ b/content/actions/guides/about-service-containers.md @@ -47,7 +47,7 @@ You can use the `services` keyword to create service containers that are part of This example creates a service called `redis` in a job called `container-job`. The Docker host in this example is the `node:10.18-jessie` container. {% raw %} -```yaml +```yaml{:copy} name: Redis container example on: push @@ -89,7 +89,7 @@ When you specify the Docker host port but not the container port, the container This example maps the service container `redis` port 6379 to the Docker host port 6379. {% raw %} -```yaml +```yaml{:copy} name: Redis Service Example on: push diff --git a/content/actions/guides/building-and-testing-java-with-ant.md b/content/actions/guides/building-and-testing-java-with-ant.md index 96019ea729..3f062ffb28 100644 --- a/content/actions/guides/building-and-testing-java-with-ant.md +++ b/content/actions/guides/building-and-testing-java-with-ant.md @@ -38,7 +38,7 @@ To get started quickly, you can choose the preconfigured Ant template when you c You can also add this workflow manually by creating a new file in the `.github/workflows` directory of your repository. {% raw %} -```yaml +```yaml{:copy} name: Java CI on: [push] @@ -79,7 +79,7 @@ The starter workflow will run the default target specified in your _build.xml_ f If you use different commands to build your project, or you want to run a different target, you can specify those. For example, you may want to run the `jar` target that's configured in your _build-ci.xml_ file. {% raw %} -```yaml +```yaml{:copy} steps: - uses: actions/checkout@v2 - uses: actions/setup-java@v1 @@ -97,7 +97,7 @@ After your build has succeeded and your tests have passed, you may want to uploa Ant will usually create output files like JARs, EARs, or WARs in the `build/jar` directory. You can upload the contents of that directory using the `upload-artifact` action. {% raw %} -```yaml +```yaml{:copy} steps: - uses: actions/checkout@v2 - uses: actions/setup-java@v1 diff --git a/content/actions/guides/building-and-testing-java-with-gradle.md b/content/actions/guides/building-and-testing-java-with-gradle.md index 67e760c925..e3347e6cd1 100644 --- a/content/actions/guides/building-and-testing-java-with-gradle.md +++ b/content/actions/guides/building-and-testing-java-with-gradle.md @@ -38,7 +38,7 @@ To get started quickly, you can choose the preconfigured Gradle template when yo You can also add this workflow manually by creating a new file in the `.github/workflows` directory of your repository. {% raw %} -```yaml +```yaml{:copy} name: Java CI on: [push] @@ -79,7 +79,7 @@ The starter workflow will run the `build` task by default. In the default Gradle If you use different commands to build your project, or you want to use a different task, you can specify those. For example, you may want to run the `package` task that's configured in your _ci.gradle_ file. {% raw %} -```yaml +```yaml{:copy} steps: - uses: actions/checkout@v2 - uses: actions/setup-java@v1 @@ -95,7 +95,7 @@ steps: When using {% data variables.product.prodname_dotcom %}-hosted runners, you can cache your dependencies to speed up your workflow runs. After a successful run, your local Gradle package cache will be stored on GitHub Actions infrastructure. In future workflow runs, the cache will be restored so that dependencies don't need to be downloaded from remote package repositories. For more information, see "Caching dependencies to speed up workflows" and the [`cache` action](https://github.com/marketplace/actions/cache). {% raw %} -```yaml +```yaml{:copy} steps: - uses: actions/checkout@v2 - name: Set up JDK 1.8 @@ -122,7 +122,7 @@ After your build has succeeded and your tests have passed, you may want to uploa Gradle will usually create output files like JARs, EARs, or WARs in the `build/libs` directory. You can upload the contents of that directory using the `upload-artifact` action. {% raw %} -```yaml +```yaml{:copy} steps: - uses: actions/checkout@v2 - uses: actions/setup-java@v1 diff --git a/content/actions/guides/building-and-testing-java-with-maven.md b/content/actions/guides/building-and-testing-java-with-maven.md index fbc8f90151..205a4116de 100644 --- a/content/actions/guides/building-and-testing-java-with-maven.md +++ b/content/actions/guides/building-and-testing-java-with-maven.md @@ -38,7 +38,7 @@ To get started quickly, you can choose the preconfigured Maven template when you You can also add this workflow manually by creating a new file in the `.github/workflows` directory of your repository. {% raw %} -```yaml +```yaml{:copy} name: Java CI on: [push] @@ -79,7 +79,7 @@ The starter workflow will run the `package` target by default. In the default Ma If you use different commands to build your project, or you want to use a different target, you can specify those. For example, you may want to run the `verify` target that's configured in a _pom-ci.xml_ file. {% raw %} -```yaml +```yaml{:copy} steps: - uses: actions/checkout@v2 - uses: actions/setup-java@v1 @@ -95,7 +95,7 @@ steps: When using {% data variables.product.prodname_dotcom %}-hosted runners, you can cache your dependencies to speed up your workflow runs. After a successful run, your local Maven repository will be stored on GitHub Actions infrastructure. In future workflow runs, the cache will be restored so that dependencies don't need to be downloaded from remote Maven repositories. For more information, see "Caching dependencies to speed up workflows" and the [`cache` action](https://github.com/marketplace/actions/cache). {% raw %} -```yaml +```yaml{:copy} steps: - uses: actions/checkout@v2 - name: Set up JDK 1.8 @@ -122,7 +122,7 @@ After your build has succeeded and your tests have passed, you may want to uploa Maven will usually create output files like JARs, EARs, or WARs in the `target` directory. To upload those as artifacts, you can copy them into a new directory that contains artifacts to upload. For example, you can create a directory called `staging`. Then you can upload the contents of that directory using the `upload-artifact` action. {% raw %} -```yaml +```yaml{:copy} steps: - uses: actions/checkout@v2 - uses: actions/setup-java@v1 diff --git a/content/actions/guides/building-and-testing-nodejs.md b/content/actions/guides/building-and-testing-nodejs.md index 480d359be1..98d9469110 100644 --- a/content/actions/guides/building-and-testing-nodejs.md +++ b/content/actions/guides/building-and-testing-nodejs.md @@ -77,7 +77,7 @@ The template includes a matrix strategy that builds and tests your code with fou Each job can access the value defined in the matrix `node-version` array using the `matrix` context. The `setup-node` action uses the context as the `node-version` input. The `setup-node` action configures each job with a different Node.js version before building and testing code. For more information about matrix strategies and contexts, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idstrategymatrix)" and "[Context and expression syntax for {% data variables.product.prodname_actions %}](/actions/reference/context-and-expression-syntax-for-github-actions)." {% raw %} -```yaml +```yaml{:copy} strategy: matrix: node-version: [10.x, 12.x, 14.x, 15.x] @@ -93,7 +93,7 @@ steps: Alternatively, you can build and test with exact Node.js versions. -```yaml +```yaml{:copy} strategy: matrix: node-version: [8.16.2, 10.17.0] @@ -102,7 +102,7 @@ strategy: Or, you can build and test using a single version of Node.js too. {% raw %} -```yaml +```yaml{:copy} name: Node.js CI on: [push] @@ -136,7 +136,7 @@ When using {% data variables.product.prodname_dotcom %}-hosted runners, you can This example installs the dependencies defined in the *package.json* file. For more information, see [`npm install`](https://docs.npmjs.com/cli/install). -```yaml +```yaml{:copy} steps: - uses: actions/checkout@v2 - name: Use Node.js @@ -150,7 +150,7 @@ steps: Using `npm ci` installs the versions in the *package-lock.json* or *npm-shrinkwrap.json* file and prevents updates to the lock file. Using `npm ci` is generally faster than running `npm install`. For more information, see [`npm ci`](https://docs.npmjs.com/cli/ci.html) and "[Introducing `npm ci` for faster, more reliable builds](https://blog.npmjs.org/post/171556855892/introducing-npm-ci-for-faster-more-reliable)." {% raw %} -```yaml +```yaml{:copy} steps: - uses: actions/checkout@v2 - name: Use Node.js @@ -166,7 +166,7 @@ steps: This example installs the dependencies defined in the *package.json* file. For more information, see [`yarn install`](https://yarnpkg.com/en/docs/cli/install). -```yaml +```yaml{:copy} steps: - uses: actions/checkout@v2 - name: Use Node.js @@ -179,7 +179,7 @@ steps: Alternatively, you can pass `--frozen-lockfile` to install the versions in the *yarn.lock* file and prevent updates to the *yarn.lock* file. -```yaml +```yaml{:copy} steps: - uses: actions/checkout@v2 - name: Use Node.js @@ -201,7 +201,7 @@ In the example below, the secret `NPM_TOKEN` stores the npm authentication token Before installing dependencies, use the `setup-node` action to create the *.npmrc* file. The action has two input parameters. The `node-version` parameter sets the Node.js version, and the `registry-url` parameter sets the default registry. If your package registry uses scopes, you must use the `scope` parameter. For more information, see [`npm-scope`](https://docs.npmjs.com/misc/scope). {% raw %} -```yaml +```yaml{:copy} steps: - uses: actions/checkout@v2 - name: Use Node.js @@ -231,7 +231,7 @@ always-auth=true When using {% data variables.product.prodname_dotcom %}-hosted runners, you can cache dependencies using a unique key, and restore the dependencies when you run future workflows using the `cache` action. For more information, see "Caching dependencies to speed up workflows" and the [`cache` action](https://github.com/marketplace/actions/cache). {% raw %} -```yaml +```yaml{:copy} steps: - uses: actions/checkout@v2 - name: Use Node.js @@ -256,7 +256,7 @@ steps: You can use the same commands that you use locally to build and test your code. For example, if you run `npm run build` to run build steps defined in your *package.json* file and `npm test` to run your test suite, you would add those commands in your workflow file. -```yaml +```yaml{:copy} steps: - uses: actions/checkout@v2 - name: Use Node.js diff --git a/content/actions/guides/building-and-testing-python.md b/content/actions/guides/building-and-testing-python.md index 6f44851aed..37941d1612 100644 --- a/content/actions/guides/building-and-testing-python.md +++ b/content/actions/guides/building-and-testing-python.md @@ -37,7 +37,7 @@ We recommend that you have a basic understanding of Python, PyPy, and pip. For m To get started quickly, add the template to the `.github/workflows` directory of your repository. {% raw %} -```yaml +```yaml{:copy} name: Python package on: [push] @@ -94,7 +94,7 @@ If you are using a self-hosted runner, you can configure the runner to use the ` #### Using multiple Python versions {% raw %} -```yaml +```yaml{:copy} name: Python package on: [push] @@ -126,7 +126,7 @@ jobs: You can configure a specific version of python. For example, 3.8. Alternatively, you can use semantic version syntax to get the latest minor release. This example uses the latest minor release of Python 3. {% raw %} -```yaml +```yaml{:copy} name: Python package on: [push] @@ -158,7 +158,7 @@ If you specify a version of Python that is not available, `setup-python` fails w You can also use the `exclude` keyword in your workflow if there is a configuration of Python that you do not wish to run. For more information, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idstrategy)." {% raw %} -```yaml +```yaml{:copy} name: Python package on: [push] @@ -196,7 +196,7 @@ We recommend using `setup-python` to configure the version of Python used in you When using {% data variables.product.prodname_dotcom %}-hosted runners, you can also cache dependencies to speed up your workflow. For more information, see "Caching dependencies to speed up workflows." {% raw %} -```yaml +```yaml{:copy} steps: - uses: actions/checkout@v2 - name: Set up Python @@ -213,7 +213,7 @@ steps: After you update `pip`, a typical next step is to install dependencies from *requirements.txt*. {% raw %} -```yaml +```yaml{:copy} steps: - uses: actions/checkout@v2 - name: Set up Python @@ -234,7 +234,7 @@ When using {% data variables.product.prodname_dotcom %}-hosted runners, you can Pip caches dependencies in different locations, depending on the operating system of the runner. The path you'll need to cache may differ from the Ubuntu example below depending on the operating system you use. For more information, see [Python caching examples](https://github.com/actions/cache/blob/main/examples.md#python---pip). {% raw %} -```yaml +```yaml{:copy} steps: - uses: actions/checkout@v2 - name: Setup Python @@ -271,7 +271,7 @@ You can use the same commands that you use locally to build and test your code. This example installs or upgrades `pytest` and `pytest-cov`. Tests are then run and output in JUnit format while code coverage results are output in Cobertura. For more information, see [JUnit](https://junit.org/junit5/) and [Cobertura](https://cobertura.github.io/cobertura/). {% raw %} -```yaml +```yaml{:copy} steps: - uses: actions/checkout@v2 - name: Set up Python @@ -295,7 +295,7 @@ steps: The following example installs or upgrades `flake8` and uses it to lint all files. For more information, see [Flake8](http://flake8.pycqa.org/en/latest/). {% raw %} -```yaml +```yaml{:copy} steps: - uses: actions/checkout@v2 - name: Set up Python @@ -318,7 +318,7 @@ steps: With {% data variables.product.prodname_actions %}, you can run tests with tox and spread the work across multiple jobs. You'll need to invoke tox using the `-e py` option to choose the version of Python in your `PATH`, rather than specifying a specific version. For more information, see [tox](https://tox.readthedocs.io/en/latest/). {% raw %} -```yaml +```yaml{:copy} name: Python package on: [push] @@ -352,7 +352,7 @@ You can upload artifacts to view after a workflow completes. For example, you ma The following example demonstrates how you can use the `upload-artifact` action to archive test results from running `pytest`. For more information, see the [`upload-artifact` action](https://github.com/actions/upload-artifact). {% raw %} -```yaml +```yaml{:copy} name: Python package on: [push] @@ -395,7 +395,7 @@ You can configure your workflow to publish your Python package to any package re You can store any access tokens or credentials needed to publish your package using secrets. The following example creates and publishes a package to PyPI using `twine` and `dist`. For more information, see "[Creating and using encrypted secrets](/github/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets)." {% raw %} -```yaml +```yaml{:copy} name: Upload Python Package on: diff --git a/content/actions/guides/caching-dependencies-to-speed-up-workflows.md b/content/actions/guides/caching-dependencies-to-speed-up-workflows.md index 1e43aea478..9954a6229d 100644 --- a/content/actions/guides/caching-dependencies-to-speed-up-workflows.md +++ b/content/actions/guides/caching-dependencies-to-speed-up-workflows.md @@ -68,7 +68,7 @@ For more information, see [`actions/cache`](https://github.com/actions/cache). This example creates a new cache when the packages in `package-lock.json` file change, or when the runner's operating system changes. The cache key uses contexts and expressions to generate a key that includes the runner's operating system and a SHA-256 hash of the `package-lock.json` file. {% raw %} -```yaml +```yaml{:copy} name: Caching with npm on: push diff --git a/content/actions/guides/creating-postgresql-service-containers.md b/content/actions/guides/creating-postgresql-service-containers.md index e3967ef172..76a41c11a9 100644 --- a/content/actions/guides/creating-postgresql-service-containers.md +++ b/content/actions/guides/creating-postgresql-service-containers.md @@ -37,7 +37,7 @@ You may also find it helpful to have a basic understanding of YAML, the syntax f {% data reusables.github-actions.copy-workflow-file %} {% raw %} -```yaml +```yaml{:copy} name: PostgreSQL service example on: push @@ -94,7 +94,7 @@ jobs: {% data reusables.github-actions.postgres-label-description %} -```yaml +```yaml{:copy} jobs: # Label of the container job container-job: @@ -124,7 +124,7 @@ jobs: {% data reusables.github-actions.service-template-steps %} -```yaml +```yaml{:copy} steps: # Downloads a copy of the code in your repository before running CI tests - name: Check out repository code @@ -159,7 +159,7 @@ When you run a job directly on the runner machine, you'll need to map the ports {% data reusables.github-actions.copy-workflow-file %} {% raw %} -```yaml +```yaml{:copy} name: PostgreSQL Service Example on: push @@ -220,7 +220,7 @@ jobs: The workflow maps port 5432 on the PostgreSQL service container to the Docker host. For more information about the `ports` keyword, see "[About service containers](/actions/automating-your-workflow-with-github-actions/about-service-containers#mapping-docker-host-and-service-container-ports)." -```yaml +```yaml{:copy} jobs: # Label of the runner job runner-job: @@ -251,7 +251,7 @@ jobs: {% data reusables.github-actions.service-template-steps %} -```yaml +```yaml{:copy} steps: # Downloads a copy of the code in your repository before running CI tests - name: Check out repository code @@ -287,7 +287,7 @@ You can modify *client.js* to include any PostgreSQL operations needed by your w {% data reusables.github-actions.service-container-add-script %} -```javascript +```javascript{:copy} const { Client } = require('pg'); const pgclient = new Client({ diff --git a/content/actions/guides/creating-redis-service-containers.md b/content/actions/guides/creating-redis-service-containers.md index 4b7c9918c4..ae29fc7e07 100644 --- a/content/actions/guides/creating-redis-service-containers.md +++ b/content/actions/guides/creating-redis-service-containers.md @@ -37,7 +37,7 @@ You may also find it helpful to have a basic understanding of YAML, the syntax f {% data reusables.github-actions.copy-workflow-file %} {% raw %} -```yaml +```yaml{:copy} name: Redis container example on: push @@ -91,7 +91,7 @@ jobs: {% data reusables.github-actions.redis-label-description %} -```yaml +```yaml{:copy} jobs: # Label of the container job container-job: @@ -118,7 +118,7 @@ jobs: {% data reusables.github-actions.service-template-steps %} -```yaml +```yaml{:copy} steps: # Downloads a copy of the code in your repository before running CI tests - name: Check out repository code @@ -152,7 +152,7 @@ When you run a job directly on the runner machine, you'll need to map the ports {% data reusables.github-actions.copy-workflow-file %} {% raw %} -```yaml +```yaml{:copy} name: Redis runner example on: push @@ -210,7 +210,7 @@ jobs: The workflow maps port 6379 on the Redis service container to the Docker host. For more information about the `ports` keyword, see "[About service containers](/actions/automating-your-workflow-with-github-actions/about-service-containers#mapping-docker-host-and-service-container-ports)." -```yaml +```yaml{:copy} jobs: # Label of the runner job runner-job: @@ -238,7 +238,7 @@ jobs: {% data reusables.github-actions.service-template-steps %} -```yaml +```yaml{:copy} steps: # Downloads a copy of the code in your repository before running CI tests - name: Check out repository code @@ -274,7 +274,7 @@ You can modify *client.js* to include any Redis operations needed by your workfl {% data reusables.github-actions.service-container-add-script %} -```javascript +```javascript{:copy} const redis = require("redis"); // Creates a new Redis client diff --git a/content/actions/guides/publishing-docker-images.md b/content/actions/guides/publishing-docker-images.md index b0f2ca729f..7d372f4a1e 100644 --- a/content/actions/guides/publishing-docker-images.md +++ b/content/actions/guides/publishing-docker-images.md @@ -55,7 +55,7 @@ The `build-push-action` options required for Docker Hub are: * `repository`: Your Docker Hub repository in the format `DOCKER-HUB-NAMESPACE/DOCKER-HUB-REPOSITORY`. {% raw %} -```yaml +```yaml{:copy} name: Publish Docker image on: release: @@ -93,7 +93,7 @@ The `build-push-action` options required for {% data variables.product.prodname_ * `repository`: Must be set in the format `OWNER/REPOSITORY/IMAGE_NAME`. For example, for an image named `octo-image` stored on {% data variables.product.prodname_dotcom %} at `http://github.com/octo-org/octo-repo`, the `repository` option should be set to `octo-org/octo-repo/octo-image`. {% raw %} -```yaml +```yaml{:copy} name: Publish Docker image on: release: @@ -126,7 +126,7 @@ In a single workflow, you can publish your Docker image to multiple registries b The following example workflow uses the `build-push-action` steps from the previous sections ("[Publishing images to Docker Hub](#publishing-images-to-docker-hub)" and "[Publishing images to {% data variables.product.prodname_registry %}](#publishing-images-to-github-packages)") to create a single workflow that pushes to both registries. {% raw %} -```yaml +```yaml{:copy} name: Publish Docker image on: release: diff --git a/content/actions/guides/publishing-java-packages-with-gradle.md b/content/actions/guides/publishing-java-packages-with-gradle.md index 7eca03c8c0..351685c7cd 100644 --- a/content/actions/guides/publishing-java-packages-with-gradle.md +++ b/content/actions/guides/publishing-java-packages-with-gradle.md @@ -43,7 +43,7 @@ Each time you create a new release, you can trigger a workflow to publish your p You can define a new Maven repository in the publishing block of your _build.gradle_ file that points to your package repository. For example, if you were deploying to the Maven Central Repository through the OSSRH hosting project, your _build.gradle_ could specify a repository with the name `"OSSRH"`. {% raw %} -```groovy +```groovy{:copy} publishing { ... @@ -67,7 +67,7 @@ In the deploy step, you’ll need to set environment variables for the username {% raw %} -```yaml +```yaml{:copy} name: Publish package to the Maven Central Repository on: release: @@ -105,7 +105,7 @@ The `GITHUB_TOKEN` exists in your repository by default and has read and write p For example, if your organization is named "octocat" and your repository is named "hello-world", then the {% data variables.product.prodname_registry %} configuration in _build.gradle_ would look similar to the below example. {% raw %} -```groovy +```groovy{:copy} publishing { ... @@ -126,7 +126,7 @@ publishing { With this configuration, you can create a workflow that publishes your package to the Maven Central Repository by running the `gradle publish` command. {% raw %} -```yaml +```yaml{:copy} name: Publish package to GitHub Packages on: release: @@ -162,7 +162,7 @@ For example, if you deploy to the Central Repository through the OSSRH hosting p If your organization is named "octocat" and your repository is named "hello-world", then the {% data variables.product.prodname_registry %} configuration in _build.gradle_ would look similar to the below example. {% raw %} -```groovy +```groovy{:copy} publishing { ... @@ -191,7 +191,7 @@ publishing { With this configuration, you can create a workflow that publishes your package to both the Maven Central Repository and {% data variables.product.prodname_registry %} by running the `gradle publish` command. {% raw %} -```yaml +```yaml{:copy} name: Publish package to the Maven Central Repository and GitHub Packages on: release: diff --git a/content/actions/guides/publishing-java-packages-with-maven.md b/content/actions/guides/publishing-java-packages-with-maven.md index 0b2c6c89be..e615b185ff 100644 --- a/content/actions/guides/publishing-java-packages-with-maven.md +++ b/content/actions/guides/publishing-java-packages-with-maven.md @@ -47,7 +47,7 @@ In this workflow, you can use the `setup-java` action. This action installs the For example, if you were deploying to the Maven Central Repository through the OSSRH hosting project, your _pom.xml_ could specify a distribution management repository with the `id` of `ossrh`. {% raw %} -```xml +```xml{:copy} ... @@ -67,7 +67,7 @@ In the deploy step, you’ll need to set the environment variables to the userna {% raw %} -```yaml +```yaml{:copy} name: Publish package to the Maven Central Repository on: release: @@ -113,7 +113,7 @@ For a Maven-based project, you can make use of these settings by creating a dist For example, if your organization is named "octocat" and your repository is named "hello-world", then the {% data variables.product.prodname_registry %} configuration in _pom.xml_ would look similar to the below example. {% raw %} -```xml +```xml{:copy} ... @@ -130,7 +130,7 @@ For example, if your organization is named "octocat" and your repository is name With this configuration, you can create a workflow that publishes your package to {% data variables.product.prodname_registry %} by making use of the automatically generated _settings.xml_. {% raw %} -```yaml +```yaml{:copy} name: Publish package to GitHub Packages on: release: @@ -165,7 +165,7 @@ You can publish your packages to both the Maven Central Repository and {% data v Ensure your _pom.xml_ file includes a distribution management repository for both your {% data variables.product.prodname_dotcom %} repository and your Maven Central Repository provider. For example, if you deploy to the Central Repository through the OSSRH hosting project, you might want to specify it in a distribution management repository with the `id` set to `ossrh`, and you might want to specify {% data variables.product.prodname_registry %} in a distribution management repository with the `id` set to `github`. {% raw %} -```yaml +```yaml{:copy} name: Publish package to the Maven Central Repository and GitHub Packages on: release: diff --git a/content/actions/guides/publishing-nodejs-packages.md b/content/actions/guides/publishing-nodejs-packages.md index 8b79ba457c..726e1f9bd2 100644 --- a/content/actions/guides/publishing-nodejs-packages.md +++ b/content/actions/guides/publishing-nodejs-packages.md @@ -54,7 +54,7 @@ If you're publishing a package that includes a scope prefix, include the scope i This example stores the `NPM_TOKEN` secret in the `NODE_AUTH_TOKEN` environment variable. When the `setup-node` action creates an *.npmrc* file, it references the token from the `NODE_AUTH_TOKEN` environment variable. {% raw %} -```yaml +```yaml{:copy} name: Node.js Package on: release: @@ -114,7 +114,7 @@ If you want to publish your package to a different repository, you must use a pe This example stores the `GITHUB_TOKEN` secret in the `NODE_AUTH_TOKEN` environment variable. When the `setup-node` action creates an *.npmrc* file, it references the token from the `NODE_AUTH_TOKEN` environment variable. {% raw %} -```yaml +```yaml{:copy} name: Node.js Package on: release: @@ -151,7 +151,7 @@ always-auth=true If you use the Yarn package manager, you can install and publish packages using Yarn. {% raw %} -```yaml +```yaml{:copy} name: Node.js Package on: release: @@ -196,7 +196,7 @@ When you use the `scope` input to the `setup-node` action, the action creates an This workflow calls the `setup-node` action two times. Each time the `setup-node` action runs, it overwrites the *.npmrc* file. The *.npmrc* file references the token that allows you to perform authenticated operations against the package registry from the `NODE_AUTH_TOKEN` environment variable. The workflow sets the `NODE_AUTH_TOKEN` environment variable each time the `npm publish` command is run, first with a token to publish to npm (`NPM_TOKEN`) and then with a token to publish to {% data variables.product.prodname_registry %} (`GITHUB_TOKEN`). {% raw %} -```yaml +```yaml{:copy} name: Node.js Package on: release: diff --git a/content/actions/guides/storing-workflow-data-as-artifacts.md b/content/actions/guides/storing-workflow-data-as-artifacts.md index 763158ff58..a382ebc76b 100644 --- a/content/actions/guides/storing-workflow-data-as-artifacts.md +++ b/content/actions/guides/storing-workflow-data-as-artifacts.md @@ -79,7 +79,7 @@ This example shows you how to create a workflow for a Node.js project that build The workflow uploads the production artifacts in the `dist` directory, but excludes any markdown files. It also and uploads the `code-coverage.html` report as another artifact. -```yaml +```yaml{:copy} name: Node CI on: [push] @@ -114,7 +114,7 @@ jobs: You can define a custom retention period for individual artifacts created by a workflow. When using a workflow to create a new artifact, you can use `retention-days` with the `upload-artifact` action. This example demonstrates how to set a custom retention period of 5 days for the artifact named `my-artifact`: -```yaml +```yaml{:copy} - name: 'Upload Artifact' uses: actions/upload-artifact@v2 with: @@ -183,7 +183,7 @@ Job 3 displays the result uploaded in the previous job: The full math operation performed in this workflow example is `(3 + 7) x 9 = 90`. -```yaml +```yaml{:copy} name: Share data between jobs on: [push] diff --git a/data/reusables/github-actions/java-jvm-architecture.md b/data/reusables/github-actions/java-jvm-architecture.md index 2ad79b4182..33c7bd3120 100644 --- a/data/reusables/github-actions/java-jvm-architecture.md +++ b/data/reusables/github-actions/java-jvm-architecture.md @@ -5,7 +5,7 @@ The starter workflow template sets up the `PATH` to contain OpenJDK 8 for the x6 For example, to use version 9.0.4 of the JDK for the x64 platform, you can use the `setup-java` action and configure the `java-version` and `architecture` parameters to `'9.0.4'` and `x64`. {% raw %} -```yaml +```yaml{:copy} steps: - uses: actions/checkout@v2 - name: Set up JDK 9.0.4 for x64